Adds proper documentation for rsa_encrypt and rsa_decrypt. #598
+250
−0
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
Superhepper
requested review from
Firstyear,
hug-dev,
ionut-arm and
wiktor-k
wiktor-k
previously approved these changes
Nov 20, 2025
Comment on lines
18
to
19
| /// "This command performs RSA encryption using the indicated padding scheme according to IETF RFC | ||
| /// 8017." |
Collaborator
There was a problem hiding this comment.
I think this is a quote from the spec...? I wonder if this would look better in the rendered output:
Suggested change
| /// "This command performs RSA encryption using the indicated padding scheme according to IETF RFC | |
| /// 8017." | |
| /// > This command performs RSA encryption using the indicated padding scheme according to IETF [RFC 8017](https://www.rfc-editor.org/rfc/rfc8017). |
Collaborator
Author
There was a problem hiding this comment.
Yeah it is a quote from the spec therefore I added the quotation marks. But I think it might be better if I make it more clear and use the Spec references. I shall see what I can do.
Collaborator
There was a problem hiding this comment.
Yep. I just wondered if using markdown style for quotes (>) would make the rendered output look better than just regular quote signs.
| /// # ) | ||
| /// # .expect("Should be possible to create primary key from using valid Public object.") | ||
| /// # .key_handle; | ||
| /// // Because the key was created RsaScheme::Null it is possible to |
Collaborator
There was a problem hiding this comment.
Suggested change
| /// // Because the key was created RsaScheme::Null it is possible to | |
| /// // Because the key was created with RsaScheme::Null it is possible to |
Comment on lines
172
to
173
| /// "This command performs RSA decryption using the indicated padding scheme according to IETF RFC | ||
| /// 8017 ((PKCS#1)." |
Collaborator
There was a problem hiding this comment.
Suggested change
| /// "This command performs RSA decryption using the indicated padding scheme according to IETF RFC | |
| /// 8017 ((PKCS#1)." | |
| /// > This command performs RSA encryption using the indicated padding scheme according to IETF [RFC 8017](https://www.rfc-editor.org/rfc/rfc8017). |
Signed-off-by: Jesper Brynolf <[email protected]>
Superhepper
force-pushed
the
Doc-Asymmetric-Primitives
branch
from
addf239 to
1c30489
Compare
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.
No description provided.