Closed
Description
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.
Metadata
Metadata
Assignees
Labels
Area: Lints (warnings about flaws in source code) such as unused_mut.Category: PRs that clean code up or issues documenting cleanup.Category: Future-incompatibility lintsCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Activity
[-]Make use `doc(plugins)`, `doc(passes)`, etc. a hard error[/-][+]Upgrade `doc(plugins)`, `doc(passes)`, etc. deprecation warnings to hard errors[/+]jyn514 commentedon 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 commentedon 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 commentedon Mar 6, 2021
You don't think we should make it a hard error or you don't think we should make it deny-by-default?
camelid commentedon Mar 6, 2021
Also, I thought
doc(passes)
was deprecated, but I don't get any errors or warnings on nightly.jyn514 commentedon Mar 7, 2021
I don't think it should be made an error (either kind). Deprecating it seems ok though.
Manishearth commentedon Mar 7, 2021
We should just include them in
INVALID_DOC_ATTRIBUTES
. No hard errors without going through future incompat machinery or editions please.rustdoc --passes
andrustdoc --no-defaults
have no effect #91714[-]Upgrade `doc(plugins)`, `doc(passes)`, etc. deprecation warnings to hard errors[/-][+]Add `doc(plugins)`, `doc(passes)`, etc. to INVALID_DOC_ATTRIBUTES[/+]15 remaining items