fix: documentation issues (#92, #132, #173)#204
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes documentation errors in code examples across three files, correcting variable names and API usage to match the actual implementation.
- Corrected incorrect variable reference in
cipher.dartexample (usingsinkinstead of undefinedencryptedSink) - Updated
RsaPssinstantiation to use the factory constructor pattern (RsaPss.sha256()) - Fixed method call to extract bytes from the correct object (
sharedSecretinstead ofaliceKeyPair)
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| cryptography/lib/src/cryptography/cipher.dart | Fixed variable name in documentation example from encryptedSink to sink to match the declared variable |
| cryptography/lib/src/cryptography/algorithms.dart | Updated RsaPss instantiation pattern from constructor to factory method (RsaPss.sha256()) |
| cryptography/README.md | Corrected method call to extract bytes from sharedSecret instead of aliceKeyPair in key agreement example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.