docs: fixed internal links #428
Closed
Conversation
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
tarcieri
reviewed
Feb 14, 2022
| /// | ||
| /// The `E` type parameter can be any type which impls [`Encoding`] such as | ||
| /// [`Base64`] or [`Base64Unpadded`]. | ||
| /// [Base64][`crate::variant::standard::Base64`] or [Base64Unpadded][`crate::variant::standard::Base64Unpadded`]. |
Member
There was a problem hiding this comment.
Check line 17 of this file. There are imports of these, although they should probably be gated on #[cfg(doc)] instead of #[cfg(docsrs)].
tarcieri
reviewed
Feb 14, 2022
| /// | ||
| /// The `E` type parameter can be any type which impls [`Encoding`] such as | ||
| /// [`Base64`] or [`Base64Unpadded`]. | ||
| /// [Base64][`crate::variant::standard::Base64`] or [Base64Unpadded][`crate::variant::standard::Base64Unpadded`]. |
Member
|
Just in general I would prefer importing the types for generating the docs instead of using both the type names and the excessively long fully qualified paths. They make the docs much harder to read if you're just looking at the source code. |
Member
|
Also it'd be good to add CI for this. Some of these were "working" but not with the same rustdoc configuration. |
Member
|
Note that we now CI for rustdoc building warning free (#530), so this PR seems obsolete |
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.
This pr fixes some dead internal links in the base64ct, pem_rfc7468 & pkcs1 crate.
x509 has deadlinks too but fixing them seems to be irrelevant, until #414 is merged.