Fix POD documentation: synopsis, PEM headers, sign/verify#202
Open
toddr-bot wants to merge 1 commit into
Open
Conversation
…fy docs The SYNOPSIS used undefined $rsa instead of $rsa_pub/$rsa_priv for encrypt/decrypt/verify, making copy-paste examples fail. PEM header examples had 6 trailing dashes instead of 5. sign() and verify() docs lacked return value and parameter descriptions. Also updates key size example from insecure 1024 to 2048 and clarifies SHA-256 as the unconditional default hash. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
timlegge
approved these changes
May 28, 2026
Member
timlegge
left a comment
timlegge
left a comment
There was a problem hiding this comment.
looks good. I wonder how long the wrong number of dashes were there.
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
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.
What
Fixes several documentation bugs in the POD that have accumulated over time.
Why
The SYNOPSIS is the first thing users see, and it had broken variable names
(
$rsaused where$rsa_pub/$rsa_privshould be), making copy-pasteexamples fail. PEM header examples showed wrong dash counts.
sign()andverify()lacked basic usage information (return values, parameter order).How
$rsa->encrypt()→$rsa_pub->encrypt(),$rsa->decrypt()→$rsa_priv->decrypt(),$rsa->verify()→$rsa_pub->verify()------→-----) in three headersTesting
make testpasses (667 tests).podcheckerclean (only pre-existing empty ACKNOWLEDGEMENTS warning).🤖 Generated with Claude Code
Quality Report
Changes: 1 file changed, 22 insertions(+), 18 deletions(-)
Code scan: clean
Tests: passed (OK)
Branch hygiene: clean
Generated by Kōan post-mission quality pipeline