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

RELEASE.md does not mention the change to allow adding docs to reexported items #84007

Closed
rodrimati1992 opened this issue Apr 8, 2021 · 4 comments · Fixed by #84010
Closed
Labels
T-release Relevant to the release subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@rodrimati1992
Copy link
Contributor

rodrimati1992 commented Apr 8, 2021

At some point between Rust 1.34.0 and 1.39.0, the ability to add documentation to reexported items was added, but I can't find it mentioned in either the RELEASE notes or the rust-lang.org blog posts.

Maybe this should be mentioned in the RELEASE notes for the version that added that feature?

I have a foo crate that I use to test stuff, and used cargo +1.39.0 doc to document this:

/// Ooooh, ghost!
pub use std::marker::PhantomData;

image

@rodrimati1992 rodrimati1992 changed the title Can't find mention of being able to add documentation to reexports in release notes RELEASE.md does not mention the change to allow adding docs to reexported items Apr 8, 2021
@jyn514 jyn514 added the T-release Relevant to the release subteam, which will review and decide on the PR/issue. label Apr 8, 2021
@jyn514
Copy link
Member

jyn514 commented Apr 8, 2021

This was changed in 1.38 (coincidentally also the release rust-std spiked from a 61.2 MB to 173.3 MB download).

@rodrimati1992 are you interested in making a PR?

@jyn514 jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 8, 2021
@rodrimati1992
Copy link
Contributor Author

rodrimati1992 commented Apr 8, 2021

@jyn514 Sure, what are the PRs that made this possible?

@jyn514
Copy link
Member

jyn514 commented Apr 8, 2021

Oh I have no idea 😆 I found it by bisecting.

@rodrimati1992
Copy link
Contributor Author

Looks like #63048 is it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-release Relevant to the release subteam, which will review and decide on the PR/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.

2 participants