Skip to content

fix cdata formatting #2855

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.

Sign up for GitHub

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 1 commit into from
Jul 30, 2019
Merged

fix cdata formatting #2855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 4 additions & 9 deletions xml/System.Text.RegularExpressions/GroupCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -816,16 +816,13 @@ This member is an explicit interface member implementation. It can be used only
<summary>Provides an enumerator that iterates through the group collection.</summary>
<returns>An enumerator that contains all names and objects in the <see cref="T:System.Text.RegularExpressions.Group" /> collection.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks


Instead of calling this method to retrieve an enumerator that lets you iterate through the <xref:System.Text.RegularExpressions.Group> objects in the collection, you should use the group iteration construct (such as `foreach` in C# and `For Each`…`Next` in Visual Basic) that is provided by your programming language.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -859,15 +856,13 @@ Instead of calling this method to retrieve an enumerator that lets you iterate t
<summary>Provides an enumerator that iterates through the group collection.</summary>
<returns>An enumerator that contains all <see cref="T:System.Text.RegularExpressions.Group" /> objects in the group collection.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

Instead of calling this method to retrieve an enumerator that lets you iterate through the <xref:System.Text.RegularExpressions.Group> objects in the collection, you should use the group iteration construct (such as `foreach` in C# and `For Each`…`Next` in Visual Basic) that is provided by your programming language.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down
6 changes: 3 additions & 3 deletions xml/System/FormattableString.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,7 @@
<summary>Returns a result string in which arguments are formatted by using the conventions of the current culture.</summary>
<returns>The string that results from formatting the current instance by using the conventions of the current culture.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

### Remarks

Expand All @@ -163,7 +162,8 @@ Within the scope of that import directive, an interpolated string may be formatt
CurrentCulture($"{{ lat = {latitude}; lon = {longitude} }}");
```

]]></format>.</remarks>
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Format">
Expand Down
12 changes: 4 additions & 8 deletions xml/System/Index.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,13 @@
<param name="fromEnd">A boolean indicating if the index is from the start (<see langword="false" />) or from the end (<see langword="true" />) of a collection.</param>
<summary>Initializes a new <see cref="T:System.Index" /> with a specified index position and a value that indicates if the index is from the start or the end of a collection.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

### Remarks

If the <see cref="T:System.Index" /> is constructed from the end, an index value of 1 points to the last element, and an index value of 0 points beyond last element.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -278,17 +276,15 @@ If the <see cref="T:System.Index" /> is constructed from the end, an index value
<summary>Calculates the offset from the start using the given collection length.</summary>
<returns>The offset.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

For performance reasons, this method does not validate if `length` or the returned value are negative. It also doesn't validate if the returned value is greater than `length`.

Collections are not expected to have a non-negative length/count. If this method's returned offset is negative and is then used to index a collection, the runtime will throw <xref:System.ArgumentOutOfRangeException>, which will have the same effect as validation.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down
12 changes: 4 additions & 8 deletions xml/System/Range.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@
<Docs>
<summary>Represents a range that has start and end indexes.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

### Remarks

Expand All @@ -42,8 +41,7 @@
int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }
```

]]>
</format>
]]></format>
</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -267,15 +265,13 @@
<summary>Returns a <see cref="T:System.Range.OffsetAndLength" /> instance with the starting offset and length of a range.</summary>
<returns>The starting offset and length of the range.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

For performance reasons, this method does't validate `length` to ensure that it is not negative. It does ensure that `length` is within the current `Range` instance.

]]>
</format>
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="length" /> is outside the bounds of the current range. </exception>
</Docs>
Expand Down
6 changes: 2 additions & 4 deletions xml/System/ReadOnlySpan`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,15 +145,13 @@ A `ReadOnlySpan<T>` instance is often used to reference the elements of an array
<param name="length">The number of elements to include.</param>
<summary>Creates a new <see cref="T:System.ReadOnlySpan`1" /> that includes a specified number of elements of an array starting at a specified index.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

### Remarks

This method returns `default` when `array` is `null`.

]]>
</format>
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="array" /> is <see langword="null" />, but <paramref name="start" /> or <paramref name="length" /> is non-zero.
Expand Down
3 changes: 1 addition & 2 deletions xml/System/SequencePosition.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,7 @@ Equality does not guarantee that the two instances point to the same location in

Equality does not guarantee that the two instances point to the same location in a <xref:System.Buffers.ReadOnlySequence`1>.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down
6 changes: 2 additions & 4 deletions xml/System/Span`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,15 +201,13 @@ If `array` is `null`, this constructor returns a `null` `Span<T>`.
<param name="length">The number of elements to include in the new <see cref="T:System.Span`1" />. </param>
<summary>Creates a new <see cref="T:System.Span`1" /> object that includes a specified number of elements of an array starting at a specified index.</summary>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

### Remarks

This method returns `default` when `array` is `null`.

]]>
</format>
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="array" /> is <see langword="null" />, but <paramref name="start" /> or <paramref name="length" /> is non-zero.
Expand Down
12 changes: 4 additions & 8 deletions xml/System/String.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4764,15 +4764,13 @@ Depending on Why you want to call the `Copy` method, there are a number of alter
<summary>Returns an enumeration of <see cref="T:System.Text.Rune" /> from this string.</summary>
<returns>A string rune enumerator.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

### Remarks

Invalid sequences are represented in the enumeration by <xref:System.Text.Rune.ReplacementChar?displayProperty=nameWithType>.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -6425,15 +6423,13 @@ String 'This is a string.' in domain 'NewDomain': 75CC8236
<summary>Returns a reference to the element of the string at index zero.</summary>
<returns>A character representing the reference to the element of the string at index zero.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

The `GetPinnableReference` method returns a character that can be used for pinning a <xref:System.String> in memory. It is required to support the use of a <xref:System.String> within a fixed statement.

]]>
</format>
]]></format>
</remarks>
<exception cref="T:System.NullReferenceException">The string is null.</exception>
</Docs>
Expand Down
6 changes: 2 additions & 4 deletions xml/System/ValueTuple.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1125,15 +1125,13 @@ The <xref:System.ValueTuple> type is not serializable in .NET Core 1.x or in the
<summary>Returns the string representation of this <see cref="T:System.ValueTuple" /> instance.</summary>
<returns>This method always returns "()".</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

## Remarks

The string returned by this method takes the form `()`.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down
6 changes: 2 additions & 4 deletions xml/System/ValueTuple`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,17 +514,15 @@ The <xref:System.ValueTuple%602> type is not serializable in .NET Core 1.x or in
<returns>
<see langword="true" /> if the current instance is equal to the specified objects; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown">
<![CDATA[
<format type="text/markdown"><![CDATA[

### Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.ValueTuple`2> instance is cast to an <xref:System.Collections.IStructuralEquatable> interface.

The <xref:System.Collections.IEqualityComparer.Equals(System.Object,System.Object)?displayProperty=nameWithType> implementation is called only if `other` is not `null`, and if it can be successfully cast to a <xref:System.ValueTuple`2> whose components are of the same types as those of the current instance. The <xref:System.Collections.IStructuralEquatable.Equals(System.Object,System.Collections.IEqualityComparer)?displayProperty=nameWithType> method first passes the <xref:System.ValueTuple`2.Item1> values of the <xref:System.ValueTuple`2> objects to be compared to the <xref:System.Collections.IEqualityComparer.Equals(System.Object,System.Object)> implementation. If this method call returns `true`, the method is called again and passed the <xref:System.ValueTuple`2.Item2> values of the two <xref:System.ValueTuple`2> instances.

]]>
</format>
]]></format>
</remarks>
</Docs>
</Member>
Expand Down