about summary refs log tree commit diff
path: root/src/test/rustdoc
diff options
context:
space:
mode:
authorCamelid <camelidcamel@gmail.com>2021-03-08 19:35:53 -0800
committerCamelid <camelidcamel@gmail.com>2021-03-15 13:59:54 -0700
commit34c6cee397183974b34a6e04c94b38202eb40caf (patch)
tree1780fe720a331dc9bcae1a0e4df3f0a25e5ca61d /src/test/rustdoc
parent2ccf06302c08d7d4911aad40e66a9a3ee731c6f9 (diff)
downloadrust-34c6cee397183974b34a6e04c94b38202eb40caf.tar.gz
rust-34c6cee397183974b34a6e04c94b38202eb40caf.zip
Rename `#[doc(spotlight)]` to `#[doc(notable_trait)]`
"spotlight" is not a very specific or self-explaining name.
Additionally, the dialog that it triggers is called "Notable traits".
So, "notable trait" is a better name.

* Rename `#[doc(spotlight)]` to `#[doc(notable_trait)]`
* Rename `#![feature(doc_spotlight)]` to `#![feature(doc_notable_trait)]`
* Update documentation
* Improve documentation
Diffstat (limited to 'src/test/rustdoc')
-rw-r--r--src/test/rustdoc/doc-notable_trait.rs (renamed from src/test/rustdoc/doc-spotlight.rs)10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/test/rustdoc/doc-spotlight.rs b/src/test/rustdoc/doc-notable_trait.rs
index ddd46c3c215..58a24b855d6 100644
--- a/src/test/rustdoc/doc-spotlight.rs
+++ b/src/test/rustdoc/doc-notable_trait.rs
@@ -1,4 +1,4 @@
-#![feature(doc_spotlight)]
+#![feature(doc_notable_trait)]
 
 pub struct Wrapper<T> {
     inner: T,
@@ -6,9 +6,9 @@ pub struct Wrapper<T> {
 
 impl<T: SomeTrait> SomeTrait for Wrapper<T> {}
 
-#[doc(spotlight)]
+#[doc(notable_trait)]
 pub trait SomeTrait {
-    // @has doc_spotlight/trait.SomeTrait.html
+    // @has doc_notable_trait/trait.SomeTrait.html
     // @has - '//code[@class="content"]' 'impl<T: SomeTrait> SomeTrait for Wrapper<T>'
     fn wrap_me(self) -> Wrapper<Self> where Self: Sized {
         Wrapper {
@@ -21,7 +21,7 @@ pub struct SomeStruct;
 impl SomeTrait for SomeStruct {}
 
 impl SomeStruct {
-    // @has doc_spotlight/struct.SomeStruct.html
+    // @has doc_notable_trait/struct.SomeStruct.html
     // @has - '//code[@class="content"]' 'impl SomeTrait for SomeStruct'
     // @has - '//code[@class="content"]' 'impl<T: SomeTrait> SomeTrait for Wrapper<T>'
     pub fn new() -> SomeStruct {
@@ -29,7 +29,7 @@ impl SomeStruct {
     }
 }
 
-// @has doc_spotlight/fn.bare_fn.html
+// @has doc_notable_trait/fn.bare_fn.html
 // @has - '//code[@class="content"]' 'impl SomeTrait for SomeStruct'
 pub fn bare_fn() -> SomeStruct {
     SomeStruct