about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJacob Hoffman-Andrews <github@hoffman-andrews.com>2021-06-13 15:38:44 -0700
committerJacob Hoffman-Andrews <github@hoffman-andrews.com>2021-06-13 17:57:16 -0700
commit74e8e7bb600212e7fef9782fde5ad9c13e1d65a0 (patch)
tree26435ec289252d6ce43b0cf3f2280f53064da32b
parent0a8629bff642c3c3b84bb644c0099194f063b627 (diff)
downloadrust-74e8e7bb600212e7fef9782fde5ad9c13e1d65a0.tar.gz
rust-74e8e7bb600212e7fef9782fde5ad9c13e1d65a0.zip
Remove must_use from ALLOWED_ATTRIBUTES
This is a fairly common attribute on methods, but is not something you
need to know when reading the method docs - the purpose of the attribute
is for the compiler to tell you about it if you forget to use a value.

Removing reclaims some valuable space in the summary of methods.
-rw-r--r--src/librustdoc/html/render/mod.rs10
-rw-r--r--src/test/rustdoc/attributes.rs8
-rw-r--r--src/test/rustdoc/cap-lints.rs3
-rw-r--r--src/test/rustdoc/must-use.rs11
-rw-r--r--src/test/rustdoc/trait-attributes.rs21
5 files changed, 3 insertions, 50 deletions
diff --git a/src/librustdoc/html/render/mod.rs b/src/librustdoc/html/render/mod.rs
index 2e940a31c2a..cd39393d03b 100644
--- a/src/librustdoc/html/render/mod.rs
+++ b/src/librustdoc/html/render/mod.rs
@@ -965,14 +965,8 @@ fn render_assoc_item(
     }
 }
 
-const ALLOWED_ATTRIBUTES: &[Symbol] = &[
-    sym::export_name,
-    sym::link_section,
-    sym::must_use,
-    sym::no_mangle,
-    sym::repr,
-    sym::non_exhaustive,
-];
+const ALLOWED_ATTRIBUTES: &[Symbol] =
+    &[sym::export_name, sym::link_section, sym::no_mangle, sym::repr, sym::non_exhaustive];
 
 fn attributes(it: &clean::Item) -> Vec<String> {
     it.attrs
diff --git a/src/test/rustdoc/attributes.rs b/src/test/rustdoc/attributes.rs
index 51cd4a6cbfd..6a588fbd56e 100644
--- a/src/test/rustdoc/attributes.rs
+++ b/src/test/rustdoc/attributes.rs
@@ -8,14 +8,6 @@ pub extern "C" fn f() {}
 #[export_name = "bar"]
 pub extern "C" fn g() {}
 
-// @matches foo/enum.Foo.html '//*[@class="rust enum"]' \
-//      '#\[repr\(i64\)\]\n#\[must_use\]'
-#[repr(i64)]
-#[must_use]
-pub enum Foo {
-    Bar,
-}
-
 // @has foo/struct.Repr.html '//*[@class="docblock type-decl"]' '#[repr(C, align(8))]'
 #[repr(C, align(8))]
 pub struct Repr;
diff --git a/src/test/rustdoc/cap-lints.rs b/src/test/rustdoc/cap-lints.rs
index b66f75695f2..15910e1e900 100644
--- a/src/test/rustdoc/cap-lints.rs
+++ b/src/test/rustdoc/cap-lints.rs
@@ -3,8 +3,7 @@
 // therefore should not concern itself with the lints.
 #[deny(warnings)]
 
-// @has cap_lints/struct.Foo.html //pre '#[must_use]'
-#[must_use]
+// @has cap_lints/struct.Foo.html //* 'Struct Foo'
 pub struct Foo {
     field: i32,
 }
diff --git a/src/test/rustdoc/must-use.rs b/src/test/rustdoc/must-use.rs
deleted file mode 100644
index b52557fe220..00000000000
--- a/src/test/rustdoc/must-use.rs
+++ /dev/null
@@ -1,11 +0,0 @@
-// @has must_use/struct.Struct.html //pre '#[must_use]'
-#[must_use]
-pub struct Struct {
-    field: i32,
-}
-
-// @has must_use/enum.Enum.html //pre '#[must_use = "message"]'
-#[must_use = "message"]
-pub enum Enum {
-    Variant(i32),
-}
diff --git a/src/test/rustdoc/trait-attributes.rs b/src/test/rustdoc/trait-attributes.rs
deleted file mode 100644
index d0dfb8759e6..00000000000
--- a/src/test/rustdoc/trait-attributes.rs
+++ /dev/null
@@ -1,21 +0,0 @@
-#![crate_name = "foo"]
-
-
-pub trait Foo {
-    // @has foo/trait.Foo.html '//div[@id="tymethod.foo"]//div[@class="code-attribute"]' '#[must_use]'
-    #[must_use]
-    fn foo();
-}
-
-#[must_use]
-pub struct Bar;
-
-impl Bar {
-    // @has foo/struct.Bar.html '//div[@id="method.bar"]//div[@class="code-attribute"]' '#[must_use]'
-    #[must_use]
-    pub fn bar() {}
-
-    // @has foo/struct.Bar.html '//div[@id="method.bar2"]//div[@class="code-attribute"]' '#[must_use]'
-    #[must_use]
-    pub fn bar2() {}
-}