Do some docs improvements #35
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
Implement a pattern we have recently been playing with. Currently public re-exports are listed in a separate section in the HTML docs. This is kinda clunky, instead use `doc(inline)`. Separately but related, put the pub re-export statements below other use statements and use `rustfmt::skip` to stop `rustfmt` from squashing them together.
No content change, just slight re-wording.
Slightly improve the documentation about using the `package` trick in the manifest when depending on this crate.
Merged
apoelstra
approved these changes
Oct 26, 2023
Merged
Kixunil
approved these changes
Oct 30, 2023
| use super::Case; | ||
|
|
||
| #[rustfmt::skip] // Keep public re-exports separate. | ||
| #[doc(inline)] | ||
| pub use self::out_bytes::OutBytes; |
There was a problem hiding this comment.
Why is this exported in the first place? This should be just mostly-internal type, downstream crates don't need to touch it.
There was a problem hiding this comment.
Its in a private module, without this it would be private to the crate - is that what we want?
Note, changing it is not in scope for this PR so we can still merge.
There was a problem hiding this comment.
🤦♂️ sorry, I thought it's in lib.rs
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.
Do a few minor improvements, note please that patch one is not just docs it introduces the
rustfmt::skiptrick for public re-exports. Its part of "docs improvements" because it includes addingdoc(inline). The other two are trivial.