Fix cargo doc warnings#2404
Open
wutchzone wants to merge 2 commits intocloudflare:masterfrom
Open
Conversation
Contributor
|
Adding docs checks to CI does seem like a good call. |
antoniovicente
approved these changes
Mar 16, 2026
LPardue
reviewed
Mar 16, 2026
Comment on lines
+1753
to
+1754
| /// | ||
| /// [`RFC9000`]: https://datatracker.ietf.org/doc/html/rfc9000#section-7.2-3 |
Contributor
There was a problem hiding this comment.
Suggested change
| /// | |
| /// [`RFC9000`]: https://datatracker.ietf.org/doc/html/rfc9000#section-7.2-3 |
Author
There was a problem hiding this comment.
I agree with mentioning the section part, but why do you think inlining the hyperlink into the text, compared to this fragment specifier method, is better? IMO, when inlined, it is much harder to read in an IDE.
Also, the connect_with_dcid has been commented in a similar fashion.
Comment on lines
1746
to
1749
| /// Creates a new client-side connection, with a custom buffer generation | ||
| /// method using the given dcid initially. | ||
| /// Be aware the RFC places requirements for unpredictability and length | ||
| /// Be aware the [`RFC9000`] places requirements for unpredictability and length | ||
| /// on the client DCID field. |
Contributor
There was a problem hiding this comment.
This results in odd grammar, better to replace the whole block with
/// Creates a new client-side connection, with a custom buffer generation method
/// using the given dcid initially. Be aware that [RFC 9000, Section
/// 7.2.3](https://datatracker.ietf.org/doc/html/rfc9000#section-7.2-3) places
/// requirements for unpredictability and length on the client DCID field.
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
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.
When running
cargo doc --workspace --all-features --no-depsit prints out plenty of warnings about invalid hyperlinks. This series fixes them all.Maybe we should add documentation generation to the pipeline so we do not have broken links in the documentation?