Skip to content

Commit 7d17255

Browse files
committed
Add dispose to doc comment
1 parent 56da8fd commit 7d17255

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/LinkDotNet.StringBuilder/ValueStringBuilder.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ namespace LinkDotNet.StringBuilder;
88
/// A string builder which minimizes as many heap allocations as possible.
99
/// </summary>
1010
/// <remarks>
11-
/// This is a ref struct which has certain limitations.
12-
/// You can only store it in a local variable or another ref struct.
11+
/// This is a ref struct which has certain limitations. You can only store it in a local variable or another ref struct.<br/><br/>
12+
/// You should dispose it after use to ensure the rented buffer is returned to the array pool.
1313
/// </remarks>
1414
[StructLayout(LayoutKind.Sequential)]
1515
[SkipLocalsInit]
@@ -294,7 +294,7 @@ public readonly int LastIndexOf(ReadOnlySpan<char> word, int startIndex)
294294
public readonly bool Equals(ReadOnlySpan<char> span) => span.SequenceEqual(AsSpan());
295295

296296
/// <summary>
297-
/// Disposes the instance and returns rented buffer from an array pool if needed.
297+
/// Disposes the instance and returns the rented buffer to the array pool if needed.
298298
/// </summary>
299299
[MethodImpl(MethodImplOptions.AggressiveInlining)]
300300
public void Dispose()

0 commit comments

Comments
 (0)