From 4dcdbb047b72639e9b2f2efe8b829b57bb73670d Mon Sep 17 00:00:00 2001
From: Buyaa Namnan <bunamnan@microsoft.com>
Date: Mon, 14 Oct 2024 12:05:42 -0700
Subject: [PATCH] Clarify return values of Base64Url.Try* methods

---
 xml/System.Buffers.Text/Base64Url.xml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/xml/System.Buffers.Text/Base64Url.xml b/xml/System.Buffers.Text/Base64Url.xml
index c193b49f70a..1b615d68d71 100644
--- a/xml/System.Buffers.Text/Base64Url.xml
+++ b/xml/System.Buffers.Text/Base64Url.xml
@@ -705,7 +705,7 @@
         <param name="bytesWritten">When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
         <summary>Decodes the span of unicode ASCII chars represented as Base64Url into binary data.</summary>
         <returns>
-          <see langword="true" /> if bytes decoded successfully, otherwise <see langword="false" />.</returns>
+          <see langword="true" /> if bytes decoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
         <remarks>To be added.</remarks>
         <exception cref="T:System.FormatException">
           <para>
@@ -740,7 +740,7 @@
         <param name="bytesWritten">When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
         <summary>Decodes the span of UTF-8 encoded text represented as Base64Url into binary data.</summary>
         <returns>
-          <see langword="true" /> if bytes decoded successfully, otherwise <see langword="false" />.</returns>
+          <see langword="true" /> if bytes decoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
         <remarks>To be added.</remarks>
         <exception cref="T:System.FormatException">
           <para>
@@ -775,7 +775,7 @@
         <param name="charsWritten">When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
         <summary>Encodes the span of binary data into unicode ASCII chars represented as Base64Url.</summary>
         <returns>
-          <see langword="true" /> if chars encoded successfully, otherwise <see langword="false" />.</returns>
+          <see langword="true" /> if chars encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
         <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
       </Docs>
     </Member>
@@ -805,7 +805,7 @@
         <param name="bytesWritten">When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized.</param>
         <summary>Encodes the span of binary data into UTF-8 encoded chars represented as Base64Url.</summary>
         <returns>
-          <see langword="true" /> if bytes encoded successfully, otherwise <see langword="false" />.</returns>
+          <see langword="true" /> if bytes encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
         <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
       </Docs>
     </Member>
@@ -844,7 +844,7 @@
           <para>The encoded text output is larger than the binary data contained in the input (the operation inflates the data).</para>
         </summary>
         <returns>
-          <see langword="true" /> if bytes encoded successfully, otherwise <see langword="false" />.</returns>
+          <see langword="true" /> if bytes encoded successfully; <see langword="false" /> if <paramref name="destination" /> is too small.</returns>
         <remarks>This implementation of the base64url encoding omits the optional padding characters.</remarks>
       </Docs>
     </Member>