Add missing rustdoc comments; enable missing_docs lint
#216
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
tarcieri
commented
Oct 29, 2022
tarcieri
commented
Oct 29, 2022
Comment on lines
+187
to
+199
| //! [`pkcs8::DecodePublicKey`]: https://docs.rs/pkcs8/latest/pkcs8/trait.DecodePublicKey.html | ||
| //! [`pkcs8::EncodePublicKey`]: https://docs.rs/pkcs8/latest/pkcs8/trait.EncodePublicKey.html |
There was a problem hiding this comment.
For some reason rustdoc is failing to link these. Not sure why, but this at least works around the bug.
There was a problem hiding this comment.
Strange. This works for me with the local cargo doc.
tarcieri
commented
Oct 29, 2022
lumag
reviewed
Oct 29, 2022
Several types and methods were missing documentation. This commit adds document and enables warnings for `missing_docs`. Additionally it updates all references to PKCS#1 RFCs to use RFC8017, which documents the latest version of PKCS#1.
tarcieri
force-pushed
the
fix-missing-docs-and-add-lint
branch
from
81d1ee7
to
29be278
Compare
|
LGTM
|
Merged
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.
Several types and methods were missing documentation.
This commit adds document and enables warnings for
missing_docs.Additionally it updates all references to PKCS#1 RFCs to use RFC8017, which documents the latest version of PKCS#1.
cc @lumag