Do not consider #[doc(hidden)] items part of the public API.
#576
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
obi1kenobi
force-pushed
the
ignore_doc_hidden_items
branch
from
a64f3fe to
5b8196f
Compare
obi1kenobi
force-pushed
the
ignore_doc_hidden_items
branch
from
49f1930 to
11b60ee
Compare
obi1kenobi
force-pushed
the
ignore_doc_hidden_items
branch
2 times, most recently
from
f367460 to
e6ac131
Compare
obi1kenobi
force-pushed
the
ignore_doc_hidden_items
branch
from
e6ac131 to
eab3b8b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on the approach that @davidhewitt and I prototyped a few months ago, which has since matured and been merged: obi1kenobi/trustfall-rustdoc-adapter#260
This gets us almost all of the edge cases around
#[doc(hidden)]: structs, fields, enums, variants, fields within variants, functions, methods, (free or associated) constants, statics, etc. There are test cases in this PR for each of them.The remaining edge cases require knowledge of whether traits are sealed, so we can accurately determine if e.g. the deletion of a
#[doc(hidden)]trait associated type is a breaking change because it might affect implementations outside the crate. Sealed traits are of interest for many other lints as well (see #5) so I'm sure we'll get that too before long.This PR should resolve a vast majority of the current false-positives encountered in practice by users of cargo-semver-checks, as measured by our study of the top 1000 Rust crates across all their releases since 2017: https://predr.ag/blog/semver-violations-are-common-better-tooling-is-the-answer/