Skip to content

Remove must_use from ALLOWED_ATTRIBUTES - #86277

Merged
bors merged 1 commit into
rust-lang:masterfrom
jsha:remove-must-use
Jun 15, 2021
Merged

Remove must_use from ALLOWED_ATTRIBUTES#86277
bors merged 1 commit into
rust-lang:masterfrom
jsha:remove-must-use

Conversation

@jsha

@jshajsha commented Jun 13, 2021

Copy link
Copy Markdown
Contributor

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, particularly when the attribute has a long string value.

As discussed in #84309. Partially addresses #81482.

r? @Manishearth

@jshajsha added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Jun 13, 2021
@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 13, 2021
@rust-log-analyzer

This comment has been minimized.

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.
@Manishearth

Copy link
Copy Markdown
Member

@bors r+

Still not sure if I 100% agree with this but I don't mind removing this. If folks complain we can put it back.

@bors

bors commented Jun 14, 2021

Copy link
Copy Markdown
Collaborator

📌 Commit 74e8e7b has been approved by Manishearth

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 14, 2021
@Manishearth

Copy link
Copy Markdown
Member

@bors rollup=maybe

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Jun 14, 2021
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, particularly when the attribute has a long string value.
As discussed in rust-lang#84309. Partially addresses rust-lang#81482.
r? `@Manishearth`
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Jun 14, 2021
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, particularly when the attribute has a long string value.
As discussed in rust-lang#84309. Partially addresses rust-lang#81482.
r? ``@Manishearth``
@JohnTitorJohnTitor mentioned this pull request Jun 15, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 15, 2021
Rollup of 10 pull requests
Successful merges:
- rust-lang#80269 (Explain non-dropped sender recv in docs)
- rust-lang#82179 (Add functions `Duration::try_from_secs_{f32, f64}`)
- rust-lang#85608 (Stabilize `ops::ControlFlow` (just the type))
- rust-lang#85792 (Refactor windows sockets impl methods)
- rust-lang#86220 (Improve maybe_uninit_extra docs)
- rust-lang#86277 (Remove must_use from ALLOWED_ATTRIBUTES)
- rust-lang#86285 (:arrow_up: rust-analyzer)
- rust-lang#86294 (Stabilize {std, core}::prelude::rust_*.)
- rust-lang#86306 (Add mailmap entries for myself)
- rust-lang#86314 (Remove trailing triple backticks in `mut_keyword` docs)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit d921055 into rust-lang:masterJun 15, 2021
@rustbotrustbot added this to the 1.55.0 milestone Jun 15, 2021
@jsha
jsha deleted the remove-must-use branch June 16, 2021 01:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@jsha@rust-log-analyzer@Manishearth@bors@rust-highfive@rustbot