Incorporate README.md into rustdoc where it wasn't already#2273
Merged
Incorporate README.md into rustdoc where it wasn't already#2273
Conversation
tarcieri
force-pushed
the
incorporate-readme-into-rustdoc
branch
from
b7b7497 to
c8573f4
Compare
The `cipher`, `crypto-common`, and `digest` crates didn't yet do this
tarcieri
force-pushed
the
incorporate-readme-into-rustdoc
branch
from
c8573f4 to
c1584f4
Compare
newpavlov
reviewed
Feb 3, 2026
newpavlov
reviewed
Feb 3, 2026
| )] | ||
| #![warn(missing_docs, rust_2018_idioms, missing_debug_implementations)] | ||
|
|
||
| //! ## Structure |
Member
There was a problem hiding this comment.
Ideally it would be nice to move this section to the readme as well, though adding the hack for intra-crate links would be a bit annoying. Otherwise docs would look a bit strange since the license section will be before this one.
Member
Author
There was a problem hiding this comment.
I think it's fine to have these sections which make heavy use of intra-rustdoc links immediately after the README.md.
It's very tedious to maintain those links otherwise.
newpavlov
approved these changes
Feb 3, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
The
cipher,crypto-common, anddigestcrates didn't yet do this