fix: Documentation issues (#92, #132, #173)

terrier989 · terrier989 · commit 4e3e6aad950b · 2025-11-21T04:49:46.000Z
diff --git a/cryptography/README.md b/cryptography/README.md
@@ -349,7 +349,7 @@ Future<void> main() async {
     keyPair: aliceKeyPair,
     remotePublicKey: bobPublicKey,
   );
-  final sharedSecretBytes = await aliceKeyPair.extractBytes();
+  final sharedSecretBytes = await sharedSecret.extractBytes();
   print('Shared secret: $sharedSecretBytes');
 }
 ```
diff --git a/cryptography/lib/src/cryptography/algorithms.dart b/cryptography/lib/src/cryptography/algorithms.dart
@@ -1605,7 +1605,7 @@ abstract class Poly1305 extends MacAlgorithm {
 /// import 'package:cryptography/cryptography.dart';
 ///
 /// Future<void> main() async {
-///   final algorithm = RsaPss(Sha256());
+///   final algorithm = RsaPss.sha256();
 ///
 ///   // Generate a key pair
 ///   final keyPair = await algorithm.newKeyPair();
diff --git a/cryptography/lib/src/cryptography/cipher.dart b/cryptography/lib/src/cryptography/cipher.dart
@@ -348,7 +348,7 @@ abstract class Cipher {
   ///       secretKey: secretKey,
   ///       nonce: nonce,
   ///     );
-  ///     await encryptedSink.addStream(encryptedStream);
+  ///     await sink.addStream(encryptedStream);
   ///   } finally {
   ///     sink.close();
   ///   }

Original file line number	Diff line number	Diff line change
`@@ -349,7 +349,7 @@ Future<void> main() async {`
`349`	`349`	`keyPair: aliceKeyPair,`
`350`	`350`	`remotePublicKey: bobPublicKey,`
`351`	`351`	`);`
`352`		`- final sharedSecretBytes = await aliceKeyPair.extractBytes();`
	`352`	`+ final sharedSecretBytes = await sharedSecret.extractBytes();`
`353`	`353`	`print('Shared secret: $sharedSecretBytes');`
`354`	`354`	`}`
`355`	`355`	```