Improve public re-exports #137
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
|
Based on discussion here: rust-bitcoin/rust-bitcoin#2088 |
Improve the public exports in two ways:
1. Inline re-exports into the docs of the module that re-exports them.
2. Separate public and private use statements
Recently we discussed a way to separate the public and private import
statements to make the code more clear and prevent `rustfmt` joining
them all together.
Separate public exports using a code block and `#[rustfmt::skip]`. Has
the nice advantage of reducing the number of `#[doc(inline)]` attributes
also.
1. Modules first, as they are part of the project's structure.
2. Private imports
3. Public re-exports (using `rustfmt::skip` to prevent merge)
Use the format
```rust
mod xyz;
mod abc;
use ...;
pub use {
...,
};
```
This patch introduces changes to the rendered HTML docs.
tcharding
force-pushed
the
10-10-import-statements
branch
from
33c7ef5 to
1d4d337
Compare
tcharding
changed the title
clarkmoody
approved these changes
Oct 12, 2023
There was a problem hiding this comment.
Don't have a strong opinion on this one, but I'm fine with it.
ACK 1d4d337
apoelstra
approved these changes
Oct 12, 2023
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.
Improve the public exports in two ways:
Recently we discussed a way to separate the public and private import statements to make the code more clear and prevent
rustfmtjoining them all together.Separate public exports using a code block and
#[rustfmt::skip]. Has the nice advantage of reducing the number of#[doc(inline)]attributes also.rustfmt::skipto prevent merge)Use the format
This patch introduces changes to the rendered HTML docs.