Skip to content

fix formatting #2826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions xml/System.Buffers/SequenceReader`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@
</Parameters>
<Docs>
<param name="delimiters">The delimiters to search for.</param>
<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>
<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>
<summary>Searches for any of a number of specified delimiters and optionally advances past the first one to be found.</summary>
<returns><see langword="true" /> if any of the given <paramref name="delimiters" /> was found.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -782,7 +782,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<Docs>
<param name="span">When the method returns, contains the data read, if any.</param>
<param name="delimiter">The delimiter to look for.</param>
<param name="delimiterEscape">>A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param>
<param name="delimiterEscape">A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param>
<param name="advancePastDelimiter"><see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
<summary>Tries to read everything up to the given <paramref name="delimiter" />, ignoring delimiters that are preceded by <paramref name="delimiterEscape" />.</summary>
<returns><see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Globalization/ISOWeek.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</Base>
<Interfaces />
<Docs>
<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>
<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>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -214,4 +214,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
34 changes: 26 additions & 8 deletions xml/System/ReadOnlySpan`1+Enumerator.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,11 @@
<Docs>
<summary>Provides an enumerator for the elements of a <see cref="T:System.ReadOnlySpan`1" />.</summary>
<remarks>
<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.
<format type="text/markdown"><![CDATA[

## Remarks

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.

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>.

Expand All @@ -42,7 +46,9 @@ Unlike some other enumerator structures in .NET, the <xref:System.ReadOnlySpan`1

- 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.

- 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>
- 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>
</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -74,13 +80,19 @@ Unlike some other enumerator structures in .NET, the <xref:System.ReadOnlySpan`1
<summary>Gets a reference to the item at the current position of the enumerator.</summary>
<value>The element in the <see cref="T:System.ReadOnlySpan`1" /> at the current position of the enumerator.</value>
<remarks>
<format type="text/markdown"><![CDATA[`Current` is undefined under either of the following conditions:
<format type="text/markdown"><![CDATA[

## Remarks

`Current` is undefined under either of the following conditions:

- 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`.

- The last call to <xref:System.ReadOnlySpan`1.Enumerator.MoveNext*> returned `false`, which indicates the end of the span.

`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>
`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>
</remarks>
</Docs>
</Member>
Expand All @@ -106,13 +118,19 @@ Unlike some other enumerator structures in .NET, the <xref:System.ReadOnlySpan`1
<Parameters />
<Docs>
<summary>Advances the enumerator to the next item of the <see cref="System.ReadOnlySpan`1" />.</summary>
<returns>`true` if the enumerator successfully advanced to the next item; `false` if the end of the span has been passed.</returns>
<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>
<remarks>
<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.
<format type="text/markdown"><![CDATA[

## Remarks

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.

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`.

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>
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
10 changes: 5 additions & 5 deletions xml/System/Span`1+Enumerator.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Unlike some other enumerator structures in .NET, the <xref:System.Span%601.Enume
- 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>
]]></format>
</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -89,7 +89,7 @@ Unlike some other enumerator structures in .NET, the <xref:System.Span%601.Enume
`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.
]]></format>
]]></format>
</remarks>
</Docs>
</Member>
Expand All @@ -115,17 +115,17 @@ Unlike some other enumerator structures in .NET, the <xref:System.Span%601.Enume
<Parameters />
<Docs>
<summary>Advances the enumerator to the next item of the <see cref="System.Span`1" />.</summary>
<returns>`true` if the enumerator successfully advanced to the next item; `false` if the end of the span has been passed.</returns>
<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>
<remarks>
<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.
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>
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>