Skip to content

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

Closed
@camelid

Description

@camelid
Member

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

Activity

added
T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
A-maybe-future-editionSomething we may consider for a future edition.
on Mar 6, 2021
changed the title [-]Make use `doc(plugins)`, `doc(passes)`, etc. a hard error[/-] [+]Upgrade `doc(plugins)`, `doc(passes)`, etc. deprecation warnings to hard errors[/+] on Mar 6, 2021
added
C-discussionCategory: Discussion or questions that doesn't represent real issues.
on Mar 6, 2021
jyn514

jyn514 commented on Mar 6, 2021

@jyn514
Member

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

jyn514 commented on Mar 6, 2021

@jyn514
Member

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

camelid

camelid commented on Mar 6, 2021

@camelid
MemberAuthor

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

camelid commented on Mar 6, 2021

@camelid
MemberAuthor

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

jyn514

jyn514 commented on Mar 7, 2021

@jyn514
Member

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

Manishearth commented on Mar 7, 2021

@Manishearth
Member

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

changed the title [-]Upgrade `doc(plugins)`, `doc(passes)`, etc. deprecation warnings to hard errors[/-] [+]Add `doc(plugins)`, `doc(passes)`, etc. to INVALID_DOC_ATTRIBUTES[/+] on Apr 26, 2023

15 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-lintsArea: Lints (warnings about flaws in source code) such as unused_mut.C-cleanupCategory: PRs that clean code up or issues documenting cleanup.C-future-incompatibilityCategory: Future-incompatibility lintsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @Manishearth@m4tx@fmease@jyn514@camelid

    Issue actions

      Add `doc(plugins)`, `doc(passes)`, etc. to INVALID_DOC_ATTRIBUTES · Issue #82824 · rust-lang/rust