]> git.lizzy.rs Git - rust.git/commitdiff
add page to the Rustdoc Book about unstable features
authorQuietMisdreavus <grey@quietmisdreavus.net>
Mon, 12 Mar 2018 22:16:21 +0000 (17:16 -0500)
committerQuietMisdreavus <grey@quietmisdreavus.net>
Mon, 12 Mar 2018 22:16:21 +0000 (17:16 -0500)
src/doc/rustdoc/src/SUMMARY.md
src/doc/rustdoc/src/unstable-features.md [new file with mode: 0644]

index 6315cb81a8495b05e0bc84d0652778ae8dabe5b8..46528187c11754eecbf2be1e59434bb2a3acaec5 100644 (file)
@@ -5,3 +5,4 @@
 - [The `#[doc]` attribute](the-doc-attribute.md)
 - [Documentation tests](documentation-tests.md)
 - [Passes](passes.md)
+- [Unstable features](unstable-features.md)
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md
new file mode 100644 (file)
index 0000000..35380cd
--- /dev/null
@@ -0,0 +1,10 @@
+# Unstable features
+
+Rustdoc is under active developement, and like the Rust compiler, some features are only available
+on the nightly releases. Some of these are new and need some more testing before they're able to get
+released to the world at large, and some of them are tied to features in the Rust compiler that are
+themselves unstable. Several features here require a matching `#![feature(...)]` attribute to
+enable, and thus are more fully documented in the [Unstable Book]. Those sections will link over
+there as necessary.
+
+[Unstable Book]: ../unstable-book/