Skip to content

Commit cc7976f

Browse files
authored
ext/sodium: Fix return-value prose for 4 encrypt/stream functions that throw SodiumException instead of returning false (#5655)
1 parent 911fe79 commit cc7976f

4 files changed

Lines changed: 4 additions & 4 deletions

reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-encrypt.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
<refsect1 role="returnvalues">
6464
&reftitle.returnvalues;
6565
<simpara>
66-
Returns the ciphertext and tag on success, &return.falseforfailure;.
66+
Returns the ciphertext and authentication tag as a string of raw binary bytes.
6767
</simpara>
6868
</refsect1>
6969

reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-ietf-encrypt.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
<refsect1 role="returnvalues">
6767
&reftitle.returnvalues;
6868
<simpara>
69-
Returns the ciphertext and tag on success, &return.falseforfailure;.
69+
Returns the ciphertext and authentication tag as a string of raw binary bytes.
7070
</simpara>
7171
</refsect1>
7272

reference/sodium/functions/sodium-crypto-aead-xchacha20poly1305-ietf-encrypt.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
<refsect1 role="returnvalues">
6868
&reftitle.returnvalues;
6969
<simpara>
70-
Returns the ciphertext and tag on success, &return.falseforfailure;.
70+
Returns the ciphertext and authentication tag as a string of raw binary bytes.
7171
</simpara>
7272
</refsect1>
7373

reference/sodium/functions/sodium-crypto-stream-xchacha20-xor-ic.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
<refsect1 role="returnvalues">
7272
&reftitle.returnvalues;
7373
<simpara>
74-
Encrypted message, &return.falseforfailure;.
74+
Encrypted message.
7575
</simpara>
7676
</refsect1>
7777

0 commit comments

Comments
 (0)