Skip to content

Conversation

@tarcieri
Copy link
Member

@tarcieri tarcieri commented 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.

cc @lumag

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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some reason rustdoc is failing to link these. Not sure why, but this at least works around the bug.

See: https://docs.rs/rsa/latest/rsa/#pkcs8-rsa-key-encoding

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strange. This works for me with the local cargo doc.

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 tarcieri force-pushed the fix-missing-docs-and-add-lint branch from 81d1ee7 to 29be278 Compare October 29, 2022 18:03
@lumag
Copy link
Contributor

lumag commented Oct 29, 2022 via email

@tarcieri tarcieri merged commit eeb18ee into master Oct 31, 2022
@tarcieri tarcieri deleted the fix-missing-docs-and-add-lint branch October 31, 2022 20:15
@tarcieri tarcieri mentioned this pull request Oct 31, 2022
takumi-earth pushed a commit to earthlings-dev/RSA that referenced this pull request Jan 27, 2026
)

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants