Skip to content

Commit 30ab2e0

Browse files
authored
fix formatting (#2826)
* fix formatting * fix formatting * fix formatting * for formatting * fix formatting
1 parent 31f3286 commit 30ab2e0

File tree

4 files changed

+35
-17
lines changed

4 files changed

+35
-17
lines changed

xml/System.Buffers/SequenceReader`1.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@
549549
</Parameters>
550550
<Docs>
551551
<param name="delimiters">The delimiters to search for.</param>
552-
<param name="advancePastDelimiter">>see langword="true" /> to move past the first instance of any of the given <paramref name="delimiters" />; <see lanword="false" /> to not move past the delimiter.</param>
552+
<param name="advancePastDelimiter"><see langword="true" /> to move past the first instance of any of the given <paramref name="delimiters" />; <see lanword="false" /> to not move past the delimiter.</param>
553553
<summary>Searches for any of a number of specified delimiters and optionally advances past the first one to be found.</summary>
554554
<returns><see langword="true" /> if any of the given <paramref name="delimiters" /> was found.</returns>
555555
<remarks>To be added.</remarks>
@@ -782,7 +782,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
782782
<Docs>
783783
<param name="span">When the method returns, contains the data read, if any.</param>
784784
<param name="delimiter">The delimiter to look for.</param>
785-
<param name="delimiterEscape">>A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param>
785+
<param name="delimiterEscape">A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param>
786786
<param name="advancePastDelimiter"><see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
787787
<summary>Tries to read everything up to the given <paramref name="delimiter" />, ignoring delimiters that are preceded by <paramref name="delimiterEscape" />.</summary>
788788
<returns><see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>

xml/System.Globalization/ISOWeek.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</Base>
1919
<Interfaces />
2020
<Docs>
21-
<summary>>Provides static members to support the ISO week date that is part of the ISO 8601 date and time standard issued by the International Organization for Standardization (ISO).</summary>
21+
<summary>Provides static members to support the ISO week date that is part of the ISO 8601 date and time standard issued by the International Organization for Standardization (ISO).</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -214,4 +214,4 @@
214214
</Docs>
215215
</Member>
216216
</Members>
217-
</Type>
217+
</Type>

xml/System/ReadOnlySpan`1+Enumerator.xml

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@
2828
<Docs>
2929
<summary>Provides an enumerator for the elements of a <see cref="T:System.ReadOnlySpan`1" />.</summary>
3030
<remarks>
31-
<format type="text/markdown"><![CDATA[The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the C# language and the [For Each...Next](~/docs/visual-basic/language-reference/statements/for-each-next-statement.md) construct in Visual Basic hides the complexity of enumerators. Instead of directly manipulating the enumerator, using `foreach` or `For Each...Next` is recommended.
31+
<format type="text/markdown"><![CDATA[
32+
33+
## Remarks
34+
35+
The C# [foreach](~/docs/csharp/language-reference/keywords/foreach-in.md) of the C# language and the [For Each...Next](~/docs/visual-basic/language-reference/statements/for-each-next-statement.md) construct in Visual Basic hides the complexity of enumerators. Instead of directly manipulating the enumerator, using `foreach` or `For Each...Next` is recommended.
3236
3337
Initially, the enumerator is positioned before the first element in the <xref:System.ReadOnlySpan`1>. At this position, <xref:System.ReadOnlySpan`1.Enumerator.Current> is undefined. You must call <xref:System.ReadOnlySpan`1.Enumerator.MoveNext%2A> to advance the enumerator to the first item in the <xref:System.ReadOnlySpan`1> before reading the value of <xref:System.ReadOnlySpan`1.Enumerator.Current>.
3438
@@ -42,7 +46,9 @@ Unlike some other enumerator structures in .NET, the <xref:System.ReadOnlySpan`1
4246
4347
- Does not implement the <xref:System.Collections.IEnumerator> or <xref:System.Collections.Generic.IEnumerator`1> interface. This is because <xref:System.ReadOnlySpan`1.Enumerator> is a [ref struct](~/docs/csharp/language-reference/keywords/ref.md#ref-struct-types) and cannot be boxed.
4448
45-
- Does not include a `Reset` method, which can set the enumerator to its initial position before the first element in the span. (The <xref:System.Collections.IEnumerator.Reset?displayProperty=nameWithType> method must be implemented as part of the interface, but most implementors either throw an exception or provide no implementation.)]]></format>
49+
- Does not include a `Reset` method, which can set the enumerator to its initial position before the first element in the span. (The <xref:System.Collections.IEnumerator.Reset?displayProperty=nameWithType> method must be implemented as part of the interface, but most implementors either throw an exception or provide no implementation.)
50+
51+
]]></format>
4652
</remarks>
4753
</Docs>
4854
<Members>
@@ -74,13 +80,19 @@ Unlike some other enumerator structures in .NET, the <xref:System.ReadOnlySpan`1
7480
<summary>Gets a reference to the item at the current position of the enumerator.</summary>
7581
<value>The element in the <see cref="T:System.ReadOnlySpan`1" /> at the current position of the enumerator.</value>
7682
<remarks>
77-
<format type="text/markdown"><![CDATA[`Current` is undefined under either of the following conditions:
83+
<format type="text/markdown"><![CDATA[
84+
85+
## Remarks
86+
87+
`Current` is undefined under either of the following conditions:
7888
7989
- Immediately after the enumerator is created, the enumerator is positioned before the first element in the span. <xref:System.ReadOnlySpan`1.Enumerator.MoveNext*> must be called to advance the enumerator to the first element of the span before reading the value of `Current`.
8090
8191
- The last call to <xref:System.ReadOnlySpan`1.Enumerator.MoveNext*> returned `false`, which indicates the end of the span.
8292
83-
`Current` returns the same value until <xref:System.ReadOnlySpan`1.Enumerator.MoveNext*> is called. <xref:System.ReadOnlySpan`1.Enumerator.MoveNext*> sets `Current` to the next item in the span.]]></format>
93+
`Current` returns the same value until <xref:System.ReadOnlySpan`1.Enumerator.MoveNext*> is called. <xref:System.ReadOnlySpan`1.Enumerator.MoveNext*> sets `Current` to the next item in the span.
94+
95+
]]></format>
8496
</remarks>
8597
</Docs>
8698
</Member>
@@ -106,13 +118,19 @@ Unlike some other enumerator structures in .NET, the <xref:System.ReadOnlySpan`1
106118
<Parameters />
107119
<Docs>
108120
<summary>Advances the enumerator to the next item of the <see cref="System.ReadOnlySpan`1" />.</summary>
109-
<returns>`true` if the enumerator successfully advanced to the next item; `false` if the end of the span has been passed.</returns>
121+
<returns><see langword="true" /> if the enumerator successfully advanced to the next item; <see langword="false" /> if the end of the span has been passed.</returns>
110122
<remarks>
111-
<format type="text/markdown"><![CDATA[After an enumerator is created, it is positioned before the first element in the span, and the first call to `MoveNext` advances the enumerator to the first item in the span.
123+
<format type="text/markdown"><![CDATA[
124+
125+
## Remarks
126+
127+
After an enumerator is created, it is positioned before the first element in the span, and the first call to `MoveNext` advances the enumerator to the first item in the span.
128+
129+
If `MoveNext` passes the end of the span, `MoveNext` returns `false`. When the enumerator is at this state, subsequent calls to `MoveNext` also return `false`.
112130
113-
If `MoveNext` passes the end of the span, `MoveNext` returns `false`. When the enumerator is at this state, subsequent calls to `MoveNext` also return `false`.]]></format>
131+
]]></format>
114132
</remarks>
115133
</Docs>
116134
</Member>
117135
</Members>
118-
</Type>
136+
</Type>

xml/System/Span`1+Enumerator.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Unlike some other enumerator structures in .NET, the <xref:System.Span%601.Enume
5252
5353
- Does not include a `Reset` method, which can set the enumerator to its initial position before the first element in the span. (The <xref:System.Collections.IEnumerator.Reset?displayProperty=nameWithType> method must be implemented as part of the interface, but most implementors either throw an exception or provide no implementation.)
5454
55-
]]></format>
55+
]]></format>
5656
</remarks>
5757
</Docs>
5858
<Members>
@@ -89,7 +89,7 @@ Unlike some other enumerator structures in .NET, the <xref:System.Span%601.Enume
8989
9090
`Current` returns the same value until <xref:System.Span%601.Enumerator.MoveNext%2A> is called. <xref:System.Span%601.Enumerator.MoveNext%2A> sets `Current` to the next item in the span.
9191
92-
]]></format>
92+
]]></format>
9393
</remarks>
9494
</Docs>
9595
</Member>
@@ -115,17 +115,17 @@ Unlike some other enumerator structures in .NET, the <xref:System.Span%601.Enume
115115
<Parameters />
116116
<Docs>
117117
<summary>Advances the enumerator to the next item of the <see cref="System.Span`1" />.</summary>
118-
<returns>`true` if the enumerator successfully advanced to the next item; `false` if the end of the span has been passed.</returns>
118+
<returns><see langword="true" /> if the enumerator successfully advanced to the next item; <see langword="false" /> if the end of the span has been passed.</returns>
119119
<remarks>
120120
<format type="text/markdown"><![CDATA[
121121
122122
After an enumerator is created, it is positioned before the first element in the span, and the first call to `MoveNext` advances the enumerator to the first item in the span.
123123
124124
If `MoveNext` passes the end of the span, `MoveNext` returns `false`. When the enumerator is at this state, subsequent calls to `MoveNext` also return `false`.
125125
126-
]]></format>
126+
]]></format>
127127
</remarks>
128128
</Docs>
129129
</Member>
130130
</Members>
131-
</Type>
131+
</Type>

0 commit comments

Comments
 (0)