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.

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

#[deprecated(since="TBD")] says "Rust version" in doc even in third party crate #118148

Closed
Noratrieb opened this issue Nov 21, 2023 · 0 comments · Fixed by #118594
Closed

#[deprecated(since="TBD")] says "Rust version" in doc even in third party crate #118148

Noratrieb opened this issue Nov 21, 2023 · 0 comments · Fixed by #118594
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. 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

@Noratrieb
Copy link
Member

#[deprecated(since = "TBD")]
pub fn x() {}

says "Deprecating in a future Rust version"

documentation saying that

but it will not be deprecated in a future Rust version, it will be deprecated in a future crate version. An easy fix would be just always saying "version" instead of "Rust version", alternatively special casing the standard library.

@Noratrieb Noratrieb added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-bug Category: This is a bug. labels Nov 21, 2023
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Nov 21, 2023
@Noratrieb Noratrieb changed the title #[deprecated] since="TBD" says "Rust version" in doc even in third party crate #[deprecated(since="TBD")] says "Rust version" in doc even in third party crate Nov 21, 2023
@Noratrieb Noratrieb removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Nov 21, 2023
@fmease fmease added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Dec 2, 2023
hdost added a commit to hdost/rust that referenced this issue Dec 4, 2023
The deprecation notice is used when in crates as well. This applies to versions Rust or Crates.

Relates rust-lang#118148
hdost added a commit to hdost/rust that referenced this issue Dec 4, 2023
The deprecation notice is used when in crates as well. This applies to versions Rust or Crates.

Fixes rust-lang#118148

Signed-off-by: Harold Dost <h.dost@criteo.com>
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Dec 5, 2023
Remove mention of rust to make the error message generic.

The deprecation notice is used when in crates as well. This applies to versions Rust or Crates.

Relates rust-lang#118148
@bors bors closed this as completed in 1b50304 Dec 5, 2023
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Dec 5, 2023
Rollup merge of rust-lang#118594 - hdost:patch-1, r=fmease

Remove mention of rust to make the error message generic.

The deprecation notice is used when in crates as well. This applies to versions Rust or Crates.

Relates rust-lang#118148
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. 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
Development

Successfully merging a pull request may close this issue.

3 participants