Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc improvements #18

Merged
merged 5 commits into from
Jun 6, 2024
Merged

Doc improvements #18

merged 5 commits into from
Jun 6, 2024

Conversation

masongup-mdsol
Copy link
Member

Improve documentation for RustDoc:

  • Add RustDoc docs to all structs and public functions
  • Include readme into lib so it shows up in RustDoc
  • Set up readme code example to run as DocTest
  • Add DocTests to other functions as well
  • Satisfy Clippy for clean run
  • Add rustfmt and clippy check to CI
  • Bump the version for deployment

ejinotti-mdsol
ejinotti-mdsol reviewed Jun 6, 2024
View reviewed changes
src/verifier.rs Outdated
@@ -5,6 +5,7 @@ use rsa::pkcs8::DecodePublicKey;
use rsa::RsaPublicKey;
use sha2::Sha512;

/// Used to verify incoming reqeusts. Struct can be initialized once and used to verify many requests.
Copy link

Choose a reason for hiding this comment

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

typo: "reqeusts"

@masongup-mdsol masongup-mdsol merged commit 4d56d51 into main Jun 6, 2024
4 checks passed
@masongup-mdsol masongup-mdsol deleted the doc-improvements branch June 6, 2024 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ejinotti-mdsol ejinotti-mdsol ejinotti-mdsol approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@masongup-mdsol @ejinotti-mdsol