Open
Conversation
This commit adds extensive YARD documentation to improve API discoverability and developer experience. Documentation coverage increased from ~76% to ~94%. Key additions: - Module and class-level documentation with usage examples - @param, @return, @raise, and @option tags for all public methods - @example blocks showing common usage patterns - @see references to related classes and RFC sections - @api private markers for internal implementation details Documented modules: - Linzer (main module with sign/verify/signature_base) - Key classes (Ed25519, ECDSA, HMAC, RSA, RSAPSS, JWS) - Key::Helper (key generation and loading methods) - Signer and Verifier modules - Signature class - Message class and adapters (Rack, Net::HTTP, http.rb, Generic) - HTTP client module and SignatureFeature for http.rb - Rack::Auth::Signature middleware - Common utilities and Options The documentation follows YARD conventions and includes: - RFC 9421 section references where applicable - Security considerations and recommendations - Algorithm-specific notes (e.g., RSA-PSS non-determinism) - Cross-references between related classes Co-authored-by: Shelley <shelley@exe.dev>
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
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.
This commit adds extensive YARD documentation to improve API discoverability and developer experience. Documentation coverage increased from ~76% to ~94%.
Key additions:
Documented modules:
The documentation follows YARD conventions and includes: