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

Document private items in CI? #303

Closed
joshlf opened this issue Aug 31, 2023 · 0 comments
Closed

Document private items in CI? #303

joshlf opened this issue Aug 31, 2023 · 0 comments
Labels
compatibility-nonbreaking Changes that are (likely to be) non-breaking

Comments

@joshlf
Copy link
Member

joshlf commented Aug 31, 2023

If we passed --document-private-items to cargo doc in CI, it'd ensure that private items' documentation compiles successfully. This isn't that important, but it makes it easier to promote private items to public ones since we ensure from the beginning that the documentation is valid.

By a similar token, we could use --document-hidden-items. This affects #[doc(hidden)] items, which are more likely to be promoted to un-hidden than private items are to be promoted to public. However, --document-hidden-items is unstable and is not recognized by cargo doc, so we could only use it on nightly, and we'd need to pass it as RUSTDOCFLAGS="-Z unstable-options --document-hidden-items". Stability is not that big of a deal because, if the option were ever removed, we could easily update our CI to no longer make use of it.

@joshlf joshlf added the compatibility-nonbreaking Changes that are (likely to be) non-breaking label Sep 1, 2023
@joshlf joshlf closed this as completed in b724152 Sep 1, 2023
@joshlf joshlf mentioned this issue Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compatibility-nonbreaking Changes that are (likely to be) non-breaking
Projects
None yet
Development

No branches or pull requests

1 participant