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

Hide constant in select! macro for docs #5617

Merged
merged 1 commit into from
Apr 12, 2023
Merged

Conversation

mTsBucy1
Copy link
Contributor

@mTsBucy1 mTsBucy1 commented Apr 12, 2023

Using a nighly rustdoc the internal BRANCHES constant may leak into private documentation.
For background see serde-rs/serde#2426.

Using the example from select! (src) and using RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo +nightly doc --no-deps --document-private-items show the problem:

  • Before the change:
    image
  • After the change:
    image

Of course there may be other such instances, I haven't exhaustively searched for them.

Copy link
Member

@taiki-e taiki-e left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@taiki-e taiki-e merged commit cf9a03c into tokio-rs:master Apr 12, 2023
@taiki-e taiki-e added the A-tokio-macros Area: The tokio-macros crate label Apr 12, 2023
@Darksonn Darksonn added A-tokio Area: The main tokio crate M-macros Module: macros in the main Tokio crate and removed A-tokio-macros Area: The tokio-macros crate labels Apr 12, 2023
taiki-e added a commit that referenced this pull request Apr 20, 2023
taiki-e added a commit that referenced this pull request Apr 20, 2023
taiki-e added a commit that referenced this pull request Apr 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-macros Module: macros in the main Tokio crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants