You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Port System.Collections.Immutable source comments to Docs (#2492)
* Port System.Collections.Immutable source comments to Docs
* Update xml/System.Collections.Immutable/ImmutableArray`1+Enumerator.xml
suggestion by rpetrusha
Co-Authored-By: Ron Petrusha <[email protected]>
Copy file name to clipboardExpand all lines: xml/System.Collections.Immutable/ImmutableArray.xml
+14-2Lines changed: 14 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -406,7 +406,13 @@
406
406
407
407
Creates an immutable array with the specified objects from another immutable array.</summary>
408
408
<returns>An immutable array that contains the specified objects from the source array.</returns>
409
-
<remarks>To be added.</remarks>
409
+
<remarks>
410
+
<formattype="text/markdown"><![CDATA[
411
+
412
+
This overload allows helper methods or custom builder classes to efficiently avoid paying a redundant tax for copying an array when the new array is a segment of an existing array.
413
+
414
+
]]></format>
415
+
</remarks>
410
416
</Docs>
411
417
</Member>
412
418
<MemberMemberName="Create<T>">
@@ -486,7 +492,13 @@
486
492
487
493
Creates an immutable array with specified objects from another array.</summary>
488
494
<returns>An immutable array that contains the specified objects from the source array.</returns>
489
-
<remarks>To be added.</remarks>
495
+
<remarks>
496
+
<formattype="text/markdown"><![CDATA[
497
+
498
+
This overload allows helper methods or custom builder classes to efficiently avoid paying a redundant tax for copying an array when the new array is a segment of an existing array.
Copy file name to clipboardExpand all lines: xml/System.Collections.Immutable/ImmutableArray`1+Enumerator.xml
+9-2Lines changed: 9 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,14 @@
25
25
<summary>An array enumerator.
26
26
27
27
**NuGet package**: <seehref="https://www.nuget.org/packages/System.Collections.Immutable/">System.Collections.Immutable</see> (<seehref="https://docs.microsoft.com/dotnet/api/system.collections.immutable?#remarks">about immutable collections and how to install</see>)</summary>
28
-
<remarks>To be added.</remarks>
28
+
<remarks>
29
+
<formattype="text/markdown"><![CDATA[
30
+
31
+
> [!IMPORTANT]
32
+
> This enumerator should **not** implement <xref:System.IDisposable>. The iterator should inline in a `foreach` loop and not result in a `try/finally` frame in the client.
0 commit comments