Remove unreachable pubs #958
Merged
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
|
|
wprzytula
requested changes
Mar 14, 2024
Lorak-mmk
force-pushed
the
remove-unreachable-pubs
branch
from
247efff to
624e445
Compare
Previously this was a struct which had only one purpose: provide some associated functions. This is exactly what a module is, so let's use a module.
Some structs / fields etc were marked as pub despite not being a part of public API. This is confusing when reading code: in order to know if something is truly public you need to check all the modules up to lib.rs to verify that each appears in some `pub use`. This commit removes all such occurrences - now something is public if and only if it is marked as pub.
Lorak-mmk
force-pushed
the
remove-unreachable-pubs
branch
from
624e445 to
8ae6a91
Compare
wprzytula
reviewed
Mar 14, 2024
In order to prevent the problem that previous commit fixed, enable this lint for all of our crates. fixup
Lorak-mmk
force-pushed
the
remove-unreachable-pubs
branch
from
8ae6a91 to
ce0e9f7
Compare
wprzytula
approved these changes
Mar 14, 2024
Merged
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.
Up until now some structs / fields etc were marked as pub despite not being a part of public API.
This is confusing when reading code: in order to know if something is truly public you need to check all the modules up to lib.rs to verify that each appears in some
pub use.This PR removes all such occurrences - now something is public if and only if it is marked as pub.
It also enables rustc lint
unreachable-pubto prevent such occurences in the future.Pre-review checklist
./docs/source/.Fixes:annotations to PR description.