Skip to content

fix: documentation issues (#92, #132, #173)#204

Merged
terrier989 merged 1 commit into
masterfrom
fix/documentation
Nov 21, 2025
Merged

fix: documentation issues (#92, #132, #173)#204
terrier989 merged 1 commit into
masterfrom
fix/documentation

Conversation

@terrier989

Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings November 21, 2025 04:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.dart example (using sink instead of undefined encryptedSink)
  • Updated RsaPss instantiation to use the factory constructor pattern (RsaPss.sha256())
  • Fixed method call to extract bytes from the correct object (sharedSecret instead of aliceKeyPair)

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.

@terrier989 terrier989 changed the title fix: Documentation issues (#92, #132, #173) fix: documentation issues (#92, #132, #173) Nov 21, 2025
@terrier989 terrier989 merged commit 5ddc5c0 into master Nov 21, 2025
27 checks passed
@terrier989 terrier989 deleted the fix/documentation branch November 21, 2025 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants