Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doc(plugins), doc(passes), etc. to INVALID_DOC_ATTRIBUTES #82824

Closed
camelid opened this issue Mar 6, 2021 · 9 comments · Fixed by #131732
Closed

Add doc(plugins), doc(passes), etc. to INVALID_DOC_ATTRIBUTES #82824

camelid opened this issue Mar 6, 2021 · 9 comments · Fixed by #131732
Assignees
@m4tx
Labels
A-lint Area: Lints (warnings about flaws in source code) such as unused_mut. C-cleanup Category: PRs that clean code up or issues documenting cleanup. C-future-incompatibility Category: Future-incompatibility lints E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@camelid
Copy link
Member

camelid commented Mar 6, 2021 •
edited by rustbot
Loading

I think we should make doc(plugins), doc(passes), and any similar attributes hard errors. doc(plugins) is a no-op, and I expect there are almost no people using it. I'm not sure about the status of doc(passes), but I think it's been deprecated for several years. There are probably other similar attributes that should become hard errors, so please comment if you know of more.

I'm not sure if we need to wait to do this in the 2021 Edition since these attributes are likely not used at all, but I'm tagging this issue as lang-team-202x-edition and will note this in the #edition 2021 Zulip stream in case it has to happen across an edition boundary.

cc #82651, #44136
cc @rust-lang/rustdoc
@camelid camelid added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-maybe-future-edition Something we may consider for a future edition. labels Mar 6, 2021
@camelid camelid changed the title Make use doc(plugins), doc(passes), etc. a hard error Upgrade doc(plugins), doc(passes), etc. deprecation warnings to hard errors Mar 6, 2021
@camelid camelid added the C-discussion Category: Discussion or questions that doesn't represent real issues. label Mar 6, 2021
@jyn514
Copy link
Member

jyn514 commented Mar 6, 2021

I think this should be part of INVALID_DOC_ATTRIBUTES and be treated the same way as all those future-deprecation warnings. I don't think they need to be special-cased to give hard errors when nothing else does.

@jyn514
Copy link
Member

jyn514 commented Mar 6, 2021

doc(passes) is a weird one because it does still work. I don't think we should make it an error.

@camelid
Copy link
Member Author

camelid commented Mar 6, 2021

I don't think we should make it an error.

You don't think we should make it a hard error or you don't think we should make it deny-by-default?

@camelid
Copy link
Member Author

camelid commented Mar 6, 2021

Also, I thought doc(passes) was deprecated, but I don't get any errors or warnings on nightly.

@jyn514
Copy link
Member

jyn514 commented Mar 7, 2021

I don't think we should make it an error.

You don't think we should make it a hard error or you don't think we should make it deny-by-default?

I don't think it should be made an error (either kind). Deprecating it seems ok though.

@Manishearth
Copy link
Member

We should just include them in INVALID_DOC_ATTRIBUTES. No hard errors without going through future incompat machinery or editions please.

@jyn514 jyn514 removed the A-maybe-future-edition Something we may consider for a future edition. label Jul 2, 2021
@camelid camelid mentioned this issue Dec 15, 2021
Closed
@jyn514 jyn514 changed the title Upgrade doc(plugins), doc(passes), etc. deprecation warnings to hard errors Add doc(plugins), doc(passes), etc. to INVALID_DOC_ATTRIBUTES Apr 26, 2023
@jyn514 jyn514 added C-cleanup Category: PRs that clean code up or issues documenting cleanup. A-lint Area: Lints (warnings about flaws in source code) such as unused_mut. C-future-incompatibility Category: Future-incompatibility lints E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. and removed C-discussion Category: Discussion or questions that doesn't represent real issues. labels Apr 26, 2023
@seqre
Copy link
Contributor

seqre commented Jan 26, 2024

Where in the codebase does this change need to happen? I tried looking for it myself, but couldn't find it.

@m4tx
Copy link
Contributor

m4tx commented Oct 15, 2024

@rustbot claim

@m4tx m4tx mentioned this issue Oct 15, 2024
Merged
@m4tx
Copy link
Contributor

m4tx commented Oct 15, 2024

This should be fixed in #131732.

I'm not quite sure how relevant this issue is today, though — INVALID_DOC_ATTRIBUTES has been made deny-by-default in Rust 1.78, so this now causes a compilation failure unless it's explicitly turned off. If there is any better way to fix this issue, I'm open to changing this PR.

@bors bors closed this as completed in 83085b9 Oct 22, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Oct 22, 2024
@rust-timer
Unrolled build for rust-lang#131732
7262b3c 
Rollup merge of rust-lang#131732 - m4tx:fix-82824, r=davidtwco

Add doc(plugins), doc(passes), etc. to INVALID_DOC_ATTRIBUTES

This fixes rust-lang#82824.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@m4tx m4tx

Labels
A-lint Area: Lints (warnings about flaws in source code) such as unused_mut. C-cleanup Category: PRs that clean code up or issues documenting cleanup. C-future-incompatibility Category: Future-incompatibility lints E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add doc(plugins), doc(passes), etc. to INVALID_DOC_ATTRIBUTES m4tx/rust
5 participants
@Manishearth @m4tx @jyn514 @camelid @seqre