Skip to content

Commit cfc4d2e

Browse files
Apply suggestions from code review
Co-authored-by: Genevieve Warren <[email protected]>
1 parent 6dc8349 commit cfc4d2e

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

xml/System/Environment+ProcessCpuUsage.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
<ReturnType>System.TimeSpan</ReturnType>
7272
</ReturnValue>
7373
<Docs>
74-
<summary>Gets the amount of time the process has spent utilizing the CPU including the process time spent in the application code and the process time spent in the operating system code.</summary>
74+
<summary>Gets the amount of time the process has spent utilizing the CPU, including the process time spent in the application code and in the operating system code.</summary>
7575
<value>To be added.</value>
7676
<remarks>To be added.</remarks>
7777
</Docs>

xml/System/Guid.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -604,8 +604,8 @@
604604
</ReturnValue>
605605
<Docs>
606606
<summary>Gets a <see cref="T:System.Guid" /> where all bits are set.</summary>
607-
<value>To be added.</value>
608-
<remarks>This returns the value: FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF</remarks>
607+
<value>A GUID with a value of FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF.</value>
608+
<remarks>To be added.</remarks>
609609
</Docs>
610610
</Member>
611611
<MemberGroup MemberName="CompareTo">
@@ -849,8 +849,8 @@
849849
<summary>Creates a new <see cref="T:System.Guid" /> according to RFC 9562, following the Version 7 format.</summary>
850850
<returns>A new <see cref="T:System.Guid" /> according to RFC 9562, following the Version 7 format.</returns>
851851
<remarks>
852-
<para>This uses <see cref="P:System.DateTimeOffset.UtcNow" /> to determine the Unix Epoch timestamp source.</para>
853-
<para>This seeds the rand_a and rand_b sub-fields with random data.</para>
852+
<para>This method uses <see cref="P:System.DateTimeOffset.UtcNow" /> to determine the Unix Epoch timestamp source.</para>
853+
<para>This method seeds the rand_a and rand_b sub-fields with random data.</para>
854854
</remarks>
855855
</Docs>
856856
</Member>
@@ -879,11 +879,11 @@
879879
<Parameter Name="timestamp" Type="System.DateTimeOffset" Index="0" FrameworkAlternate="net-9.0" />
880880
</Parameters>
881881
<Docs>
882-
<param name="timestamp">The date time offset used to determine the Unix Epoch timestamp.</param>
882+
<param name="timestamp">The date-time offset used to determine the Unix Epoch timestamp.</param>
883883
<summary>Creates a new <see cref="T:System.Guid" /> according to RFC 9562, following the Version 7 format.</summary>
884884
<returns>A new <see cref="T:System.Guid" /> according to RFC 9562, following the Version 7 format.</returns>
885885
<remarks>
886-
<para>This seeds the rand_a and rand_b sub-fields with random data.</para>
886+
<para>This method seeds the rand_a and rand_b sub-fields with random data.</para>
887887
</remarks>
888888
<exception cref="T:System.ArgumentOutOfRangeException">
889889
<paramref name="timestamp" /> represents an offset prior to <see cref="F:System.DateTimeOffset.UnixEpoch" />.</exception>
@@ -3021,8 +3021,8 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust
30213021
<summary>Gets the value of the variant field for the <see cref="T:System.Guid" />.</summary>
30223022
<value>To be added.</value>
30233023
<remarks>
3024-
<para>This corresponds to the most significant 4 bits of the 8th byte: 00000000-0000-0000-F000-000000000000. The "don't-care" bits are not masked out.</para>
3025-
<para>See RFC 9562 for more information on how to interpret this value.</para>
3024+
<para>This property corresponds to the most significant 4 bits of the 8th byte: 00000000-0000-0000-F000-000000000000. The "don't-care" bits are not masked out.</para>
3025+
<para>For more information on how to interpret this value, see <see href="https://www.rfc-editor.org/rfc/rfc9562.html">RFC 9562</see>.</para>
30263026
</remarks>
30273027
</Docs>
30283028
</Member>
@@ -3051,8 +3051,8 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust
30513051
<summary>Gets the value of the version field for the <see cref="T:System.Guid" />.</summary>
30523052
<value>To be added.</value>
30533053
<remarks>
3054-
<para>This corresponds to the most significant 4 bits of the 6th byte: 00000000-0000-F000-0000-000000000000.</para>
3055-
<para>See RFC 9562 for more information on how to interpret this value.</para>
3054+
<para>This property corresponds to the most significant 4 bits of the 6th byte: 00000000-0000-F000-0000-000000000000.</para>
3055+
<para>For more information on how to interpret this value, see <see href="https://www.rfc-editor.org/rfc/rfc9562.html">RFC 9562</see>.</para>
30563056
</remarks>
30573057
</Docs>
30583058
</Member>

xml/System/MemoryExtensions+SpanSplitEnumerator`1.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
</ReturnValue>
6363
<Docs>
6464
<summary>Gets the current element of the enumeration.</summary>
65-
<value>Returns a <see cref="T:System.Range" /> instance that indicates the bounds of the current element withing the source span.</value>
65+
<value>A <see cref="T:System.Range" /> instance that indicates the bounds of the current element withing the source span.</value>
6666
<remarks>To be added.</remarks>
6767
</Docs>
6868
</Member>
@@ -90,7 +90,7 @@
9090
<Parameters />
9191
<Docs>
9292
<summary>Gets an enumerator that allows for iteration over the split span.</summary>
93-
<returns>Returns a <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" /> that can be used to iterate over the split span.</returns>
93+
<returns>A <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" /> that can be used to iterate over the split span.</returns>
9494
<remarks>To be added.</remarks>
9595
</Docs>
9696
</Member>

xml/System/MemoryExtensions.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9339,7 +9339,7 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
93399339
<summary>
93409340
<para>Returns a type that allows for enumeration of each element within a split span using the provided separator span.</para>
93419341
</summary>
9342-
<returns>Returns a <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" />.</returns>
9342+
<returns>An enumerator that can be used to enumerate each element in a split span using the provided separator span.</returns>
93439343
<remarks>To be added.</remarks>
93449344
</Docs>
93459345
</Member>
@@ -9404,7 +9404,7 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
94049404
<summary>
94059405
<para>Returns a type that allows for enumeration of each element within a split span using the provided separator character.</para>
94069406
</summary>
9407-
<returns>Returns a <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" />.</returns>
9407+
<returns>An enumerator that can be used to enumerate each element in a split span using the provided separator character.</returns>
94089408
<remarks>To be added.</remarks>
94099409
</Docs>
94109410
</Member>
@@ -9558,14 +9558,14 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
95589558
<Docs>
95599559
<typeparam name="T">The type of the elements.</typeparam>
95609560
<param name="source">The source span to be enumerated.</param>
9561-
<param name="separators">The <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" /> to be used to split the provided span.</param>
9561+
<param name="separators">The <see cref="T:System.Buffers.SearchValues`1" /> to be used to split the provided span.</param>
95629562
<summary>
9563-
<para>Returns a type that allows for enumeration of each element within a split span using the provided <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" />.</para>
9563+
<para>Returns a type that allows for enumeration of each element within a split span using the provided separator characters.</para>
95649564
</summary>
9565-
<returns>Returns a <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" />.</returns>
9565+
<returns>An enumerator that can be used to enumerate each element in a split span using the provided separator characters.</returns>
95669566
<remarks>
9567-
<para>Unlike <see cref="M:System.MemoryExtensions.SplitAny``1(System.ReadOnlySpan{``0},System.ReadOnlySpan{``0})" />, the <paramref name="separators" /> is not checked for being empty.</para>
9568-
<para>An empty <paramref name="separators" /> will result in no separators being found, regardless of the type of <typeparamref name="T" />, whereas <see cref="M:System.MemoryExtensions.SplitAny``1(System.ReadOnlySpan{``0},System.ReadOnlySpan{``0})" /> will use all Unicode whitespace characters as separators if <paramref name="separators" /> is empty and <typeparamref name="T" /> is <see cref="T:System.Char" />.</para>
9567+
<para>Unlike <see cref="M:System.MemoryExtensions.SplitAny``1(System.ReadOnlySpan{``0},System.ReadOnlySpan{``0})" />, <paramref name="separators" /> is not checked for being empty.</para>
9568+
<para>An empty <paramref name="separators" /> argument will result in no separators being found, regardless of the type of <typeparamref name="T" />, whereas <see cref="M:System.MemoryExtensions.SplitAny``1(System.ReadOnlySpan{``0},System.ReadOnlySpan{``0})" /> uses all Unicode whitespace characters as separators if <paramref name="separators" /> is empty and <typeparamref name="T" /> is <see cref="T:System.Char" />.</para>
95699569
</remarks>
95709570
</Docs>
95719571
</Member>
@@ -9633,7 +9633,7 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
96339633
<summary>
96349634
<para>Returns a type that allows for enumeration of each element within a split span using any of the provided elements.</para>
96359635
</summary>
9636-
<returns>Returns a <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" />.</returns>
9636+
<returns>An enumerator that can be used to enumerate each element in a split span using the provided separator characters.</returns>
96379637
<remarks>
96389638
<para>If <typeparamref name="T" /> is <see cref="T:System.Char" /> and if <paramref name="separators" /> is empty, all Unicode whitespace characters are used as the separators. This matches the behavior of when <see cref="M:System.String.Split(System.Char[])" /> and related overloads are used with an empty separator array, or when <see cref="M:System.MemoryExtensions.SplitAny(System.ReadOnlySpan{System.Char},System.Span{System.Range},System.ReadOnlySpan{System.Char},System.StringSplitOptions)" /> is used with an empty separator span.</para>
96399639
</remarks>

0 commit comments

Comments
 (0)