Skip to content

Fix broken xrefs #2576

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 2 commits into from
Jun 11, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
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.IO/WindowsRuntimeStreamExtensions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Here's the XAML code that is associated with the previous example.
## Remarks

> [!NOTE]
> In Visual Basic and C#, you can call this method as an instance method on any object of type <System.IO.Stream>. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)](~/docs/visual-basic/programming-guide/language-features/procedures/extension-methods.md) or [Extension Methods (C# Programming Guide)](~/docs/csharp/programming-guide/classes-and-structs/extension-methods.md).
> In Visual Basic and C#, you can call this method as an instance method on any object of type <xref:System.IO.Stream>. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)](~/docs/visual-basic/programming-guide/language-features/procedures/extension-methods.md) or [Extension Methods (C# Programming Guide)](~/docs/csharp/programming-guide/classes-and-structs/extension-methods.md).

## Examples

Expand Down Expand Up @@ -435,7 +435,7 @@ In most situations, buffering improves the performance of stream operations. You
> [!NOTE]
> In Visual Basic and C#, you can call this method as an instance method on any object of type <xref:System.IO.Stream>. When you use instance method syntax to call this method, omit the first parameter. For more information, see [Extension Methods (Visual Basic)](~/docs/visual-basic/programming-guide/language-features/procedures/extension-methods.md) or [Extension Methods (C# Programming Guide)](~/docs/csharp/programming-guide/classes-and-structs/extension-methods.md).

A default buffer size of 16,384 bytes is used when converting the stream. To specify a different buffer size, use the <xref:> overload.
A default buffer size of 16,384 bytes is used when converting the stream. To specify a different buffer size, use the <xref:System.IO.WindowsRuntimeStreamExtensions.AsStreamForWrite(Windows.Storage.Streams.IOutputStream,System.Int32)> overload.

## Examples
The following example shows how to use the <xref:System.IO.WindowsRuntimeStreamExtensions.AsStreamForWrite%2A> and <xref:System.IO.WindowsRuntimeStreamExtensions.AsStreamForRead%2A> methods to convert a managed stream to and from a stream in the Windows Runtime.
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Text.Json/Utf8JsonWriter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To be able to format the output with indentation and white space OR to skip vali
<Docs>
<param name="bufferWriter">The destination for writing JSON text.</param>
<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
<summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.Buffers.IBufferWriter&lt;System.Byte&gt;" />.</summary>
<summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see langword="System.Buffers.IBufferWriter&lt;System.Byte&gt;" />.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="bufferWriter" /> is <see langword="null" />.</exception>
</Docs>
Expand Down
5 changes: 3 additions & 2 deletions xml/System/DateTime.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4812,7 +4812,8 @@ juillet 2009
<summary>Converts the string representation of a date and time to its <see cref="T:System.DateTime" /> equivalent.</summary>
<remarks>
<format type="text/markdown"><![CDATA[


<a name="parse-remarks"></a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is not really broken, I'd prefer that we file a bug for the build report since the current link experience is better.

## Remarks
In this section:

Expand Down Expand Up @@ -4955,7 +4956,7 @@ The `DateTime.Parse` overloads return a <xref:System.DateTime> value whose <xref

## Examples

Numerous examples that call the `DateTime.Parse` method are interspersed throughout the [Remarks](#remarks) section of this article and in the documentation for the individual `DateTime.Parse` overloads.
Numerous examples that call the `DateTime.Parse` method are interspersed throughout the [Remarks](#parse-remarks) section of this article and in the documentation for the individual `DateTime.Parse` overloads.

[!INCLUDE[interactive-note](~/includes/csharp-interactive-with-utc-note.md)]

Expand Down
12 changes: 7 additions & 5 deletions xml/System/Math.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4491,7 +4491,7 @@ Remainder = (Math.Abs(dividend) - (Math.Abs(divisor) *
<remarks>
<format type="text/markdown"><![CDATA[

<a name="remarks_round"></a>
<a name="remarks-round"></a>
## Remarks

In this section:
Expand All @@ -4500,7 +4500,7 @@ In this section:
- [Midpoint values and rounding conventions](#midpoint-values-and-rounding-conventions)
- [Rounding and precision](#rounding-and-precision)
- [Rounding and single-precision floating point values](#rounding-and-single-precision-floating-point-values)
- [Examples of individual overloads](#examples)
- [Examples of individual overloads](#round-examples)

### Which method do I call?

Expand All @@ -4513,7 +4513,7 @@ You can use the following table to select an appropriate rounding method. In add
|Round a number to a specified number of fractional digits by using the rounding to nearest convention.|<xref:System.Math.Round%28System.Decimal%2CSystem.Int32%29><br /><br /> -or-<br /><br /> <xref:System.Math.Round%28System.Double%2CSystem.Int32%29>|
|Round a number to a specified number of fractional digits by using a specified rounding convention.|<xref:System.Math.Round%28System.Decimal%2CSystem.Int32%2CSystem.MidpointRounding%29><br /><br /> -or-<br /><br /> <xref:System.Math.Round%28System.Double%2CSystem.Int32%2CSystem.MidpointRounding%29>|
|Round a <xref:System.Single> value to a specified number of fractional digits by using a specified rounding convention and minimizing the loss of precision.|Convert the <xref:System.Single> to a <xref:System.Decimal> and call <xref:System.Math.Round%28System.Decimal%2CSystem.Int32%2CSystem.MidpointRounding%29>.|
|Round a number to a specified number of fractional digits while minimizing problems of precision in rounding midpoint values.|Call a rounding method that implements a "greater than or approximately equal to" comparison. See [Rounding and precision](#Precision).|
|Round a number to a specified number of fractional digits while minimizing problems of precision in rounding midpoint values.|Call a rounding method that implements a "greater than or approximately equal to" comparison. See [Rounding and precision](#precision).|
|Round a fractional value to an integer that is greater than the fractional value. For example, round 3.1 to 4.|<xref:System.Math.Ceiling%2A>|
|Round a fractional value to an integer that is less than the fractional value. For example, round 3.9 to 3.|<xref:System.Math.Floor%2A>|

Expand Down Expand Up @@ -4555,6 +4555,7 @@ By default, the <xref:System.Math.Round%2A> method uses the rounding to nearest
|<xref:System.Math.Round%28System.Decimal%2CSystem.Int32%2CSystem.MidpointRounding%29>|Determined by `mode` parameter|
|<xref:System.Math.Round%28System.Double%2CSystem.Int32%2CSystem.MidpointRounding%29>|Determined by `mode` parameter|

<a name="precision"></a>
### Rounding and precision

In order to determine whether a rounding operation involves a midpoint value, the <xref:System.Math.Round%2A> method multiplies the original value to be rounded by 10<sup>n</sup>, where *n* is the desired number of fractional digits in the return value, and then determines whether the remaining fractional portion of the value is greater than or equal to .5. This is a slight variation on a test for equality, and as discussed in the "Testing for Equality" section of the <xref:System.Double> reference topic, tests for equality with floating-point values are problematic because of the floating-point format's issues with binary representation and precision. This means that any fractional portion of a number that is slightly less than .5 (because of a loss of precision) will not be rounded upward.
Expand All @@ -4572,7 +4573,7 @@ Problems of precision in rounding midpoint values are most likely to arise in th

- When the value to be rounded is calculated from one or more floating-point operations.

- When the value to be rounded is a <xref:System.Single> rather than a <xref:System.Double> or <xref:System.Decimal>. For more information, see the next section, [Rounding and single-precision floating-point values](#Single).
- When the value to be rounded is a <xref:System.Single> rather than a <xref:System.Double> or <xref:System.Decimal>. For more information, see the next section, [Rounding and single-precision floating-point values](#rounding-and-single-precision-floating-point-values).

In cases where the lack of precision in rounding operations is problematic, you can do the following:

Expand All @@ -4593,7 +4594,8 @@ The <xref:System.Math.Round%2A> method includes overloads that accept arguments
This unexpected result is due to a loss of precision in the conversion of the <xref:System.Single> value to a <xref:System.Double>. Because the resulting <xref:System.Double> value of 16.325000762939453 is not a midpoint value and is greater than 16.325, it is always rounded upward.

In many cases, as the example illustrates, the loss of precision can be minimized or eliminated by casting or converting the <xref:System.Single> value to a <xref:System.Decimal>. Note that, because this is a narrowing conversion, it requires using a cast operator or calling a conversion method.


<a name="round-examples"></a>
## Examples

In addition to the examples in the [Remarks](#remarks-round) section, this article includes examples that illustrate the following overloads of the `Math.Round` method:
Expand Down
1 change: 1 addition & 0 deletions xml/System/StackOverflowException.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ See the [Examples](#examples) section for an illustration of this technique.

If your app hosts the common language runtime (CLR), it can specify that the CLR should unload the application domain where the stack overflow exception occurs and let the corresponding process continue. For more information, see [ICLRPolicyManager Interface](~/docs/framework/unmanaged-api/hosting/iclrpolicymanager-interface.md).

<a name="examples"></a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Suggested change
<a name="examples"></a>

## Examples

The following example uses a counter to ensure that the number of recursive calls to the `Execute` method do not exceed a maximum defined by the MAX_RECURSIVE_CALLS constant.
Expand Down