Apply unreachable_pub lint #637
Merged
Conversation
This file contains hidden or 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
taiki-e
force-pushed
the
unreachable_pub
branch
from
b289992 to
0541a37
Compare
jeehoonkang
requested changes
Jan 3, 2021
Vtec234
approved these changes
Jan 3, 2021
Member
Vtec234
left a comment
Vtec234
left a comment
There was a problem hiding this comment.
LGTM modulo the already raised issues.
Contributor
|
bors r+ |
Contributor
|
Build succeeded: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
unreachable_publint warns items that are marked aspubbut are not actually included in the public API, and suggests usingpub(crate)instead.pub(crate)is a bit more verbose thanpub, but this should make it easier to review changes that make it difficult to tell if it will break API or not just by looking at the diff like #617 (comment). Especially, there are many such codes in crossbeam-channel and crossbeam-epoch. (Hopefully, after this patch, we can basically consider all items markedpubare public APIs, except for items that have been explicitly hidden from the public API by#[doc(hidden)].)This lint is known to have some false positives, but the crossbeam doesn't seem to be affected.