-
-
Notifications
You must be signed in to change notification settings - Fork 19
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
Implement properties around participation in public APIs on importable paths and items. #260
Conversation
45fba69
to
da6c310
Compare
Summary of changes:
pub struct Example {
#[doc(hidden)]
pub not_actually_public_api: i64,
} That case requires this new |
…e paths and items. (#260) * implement notion of 'public_api' for importable paths * Propagate deprecation and doc(hidden) info through visibility tracking. * Rc the ImportablePath inside the vertex enum. * Add public API eligibility on items for nested items' API visibility. * Add test coverage for enum variants and trait associated items. --------- Co-authored-by: Predrag Gruevski <[email protected]>
…e paths and items. (#260) * implement notion of 'public_api' for importable paths * Propagate deprecation and doc(hidden) info through visibility tracking. * Rc the ImportablePath inside the vertex enum. * Add public API eligibility on items for nested items' API visibility. * Add test coverage for enum variants and trait associated items. --------- Co-authored-by: Predrag Gruevski <[email protected]>
…e paths and items. (#260) (#298) * Implement properties around participation in public APIs on importable paths and items. (#260) * implement notion of 'public_api' for importable paths * Propagate deprecation and doc(hidden) info through visibility tracking. * Rc the ImportablePath inside the vertex enum. * Add public API eligibility on items for nested items' API visibility. * Add test coverage for enum variants and trait associated items. --------- Co-authored-by: Predrag Gruevski <[email protected]> * Skip `importable_paths` test on Rust versions prior to 1.73. --------- Co-authored-by: David Hewitt <[email protected]>
Related to obi1kenobi/cargo-semver-checks#120
Adds new properties to
ImportablePath
to probe whether an API is "public", which is currently implemented as:This was done together in collaboration with @obi1kenobi (thanks, was fun pairing!); one or both of us may pick this up again in the future time permitting. Mostly complete barring the TODOs in
edges.rs
andindexed_crate.rs
, plus test output will change once those are corrected.