Skip to content

Fix some xrefs #4624

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 4 commits into from
Mar 13, 2018
Merged

Fix some xrefs #4624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c3835e6
Fix some xrefs
svick Mar 12, 2018
0c7562f
Fixed typo
svick Mar 12, 2018
1a0b25a
Change hybrid xref links to normal xrefs
svick Mar 13, 2018
91bc3a7
Remove redundant text with bad link
svick Mar 13, 2018
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
2 changes: 1 addition & 1 deletion xml/System.Data.SqlTypes/SqlByte.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1943,7 +1943,7 @@
<summary>Subtracts the second <see cref="T:System.Data.SqlTypes.SqlByte" /> operand from the first.</summary>
<returns>The results of subtracting the second <see cref="T:System.Data.SqlTypes.SqlByte" /> operand from the first.</returns>
<remarks>
<format type="text/markdown"><![CDATA[The equivalent method for this operator is <xref:System.Data.SqlTypes.SqlByte.Subtract(System.Data.SqlTypes.SqlByte, System.Data.SqlTypes.SqlByte)?displayProperty=nameWithType>.]]></format>
<format type="text/markdown"><![CDATA[The equivalent method for this operator is <xref:System.Data.SqlTypes.SqlByte.Subtract(System.Data.SqlTypes.SqlByte,System.Data.SqlTypes.SqlByte)?displayProperty=nameWithType>.]]></format>
</remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Windows.Forms.DataVisualization.Charting/LegendItemsCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
## Remarks
Appends a custom legend item with the specified text and symbol color to the end of the collection.

To add a custom legend item that uses an image for its symbol, call the [LegendItemsCollection.Add(String, String)](<xref:System.Windows.Forms.DataVisualization.Charting.LegendItemsCollection.Add(System.String,System.String)>) method.
To add a custom legend item that uses an image for its symbol, call the <xref:System.Windows.Forms.DataVisualization.Charting.LegendItemsCollection.Add(System.String,System.String)> method.

To insert a custom <xref:System.Windows.Forms.DataVisualization.Charting.LegendItem> into the collection, use one of the <xref:System.Collections.ObjectModel.Collection%601.Insert%2A> methods of this class.

Expand Down Expand Up @@ -95,7 +95,7 @@
## Remarks
Appends a custom legend item to the collection with the specified text and image to be used as the symbol for the legend item.

To add a custom legend item that uses a color for its symbol, call the [Add(Color, String)](<xref:System.Windows.Forms.DataVisualization.Charting.LegendItemsCollection.Add(System.Drawing.Color,System.String)) method.
To add a custom legend item that uses a color for its symbol, call the <xref:System.Windows.Forms.DataVisualization.Charting.LegendItemsCollection.Add(System.Drawing.Color,System.String)> method.

To insert a <xref:System.Windows.Forms.DataVisualization.Charting.LegendItem> object into the collection use one of the <xref:System.Windows.Forms.DataVisualization.Charting.LegendItemsCollection.Insert%2A> methods of this class.

Expand Down
4 changes: 2 additions & 2 deletions xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,12 +519,12 @@
<param name="items">An <see cref="T:System.Collections.ICollection" /> of serialized state objects to be written to the database.</param>
<summary>Returns a value that indicates whether the collection of serialized state objects should be written to the database.</summary>
<returns>
<see langword="true" /> indicates that the batch should be committed; <see cref="M:System.Workflow.Runtime.Hosting.SqlWorkflowPersistenceService.System.Workflow.Runtime.IPendingWork.MustCommit(System.Collections.ICollection)" /> always returns <see langword="true" />.</returns>
<see langword="true" /> indicates that the batch should be committed.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Copy link
Contributor

Choose a reason for hiding this comment

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

The link in line 522 is also broken, but the text is redundant. Could you remove it, so that the return value description just reads, "<see langword="true" /> indicates that the batch should be committed."?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


## Remarks
<xref:System.Workflow.Runtime.Hosting.SqlWorkflowPersistenceService.System%23Workflow%23Runtime%23IPendingWork%23MustCommit(System.Collections.ICollection) always returns `true`, which instructs the workflow run-time engine to invoke <xref:System.Workflow.Runtime.Hosting.SqlWorkflowPersistenceService.System%23Workflow%23Runtime%23IPendingWork%23MustCommit(System.Collections.ICollection)> on the batch.
<xref:System.Workflow.Runtime.Hosting.SqlWorkflowPersistenceService.System%23Workflow%23Runtime%23IPendingWork%23MustCommit(System.Collections.ICollection)> always returns `true`, which instructs the workflow run-time engine to invoke <xref:System.Workflow.Runtime.Hosting.SqlWorkflowPersistenceService.System%23Workflow%23Runtime%23IPendingWork%23MustCommit(System.Collections.ICollection)> on the batch.

]]></format>
</remarks>
Expand Down
4 changes: 2 additions & 2 deletions xml/System/String.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4526,11 +4526,11 @@ In .NET Core, sorting and comparison operations are based on [Version 8.0.0 of t

String interpolation is:

- More flexible. It can be used in any string without requiring a call to a method that supports composite formatting. Otherwise, you have to call the <xref:System.String.Format%2A> method or another method that supports composite formatting, such as <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or <xref:System.Text StringBuilder AppendFormat%2A?displayProperty=nameWithType>.
- More flexible. It can be used in any string without requiring a call to a method that supports composite formatting. Otherwise, you have to call the <xref:System.String.Format%2A> method or another method that supports composite formatting, such as <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or <xref:System.Text.StringBuilder.AppendFormat%2A?displayProperty=nameWithType>.

- More readable. Because the expression to insert into a string appears in the interpolated expression rather than in a argument list, interpolated strings are far easier to code and to read. Because of their greater readability, interpolated strings can replace not only calls to composite format methods, but they can also be used in string concatenation operations to produce more concise, clearer code.

A comparison of the following two code examples illustrates the superiority of interpolated strings over string concatenation and calls to composite formatting methods. The use of mutiple string concatenation operations in the following example produces verbose and hard-to-read code.
A comparison of the following two code examples illustrates the superiority of interpolated strings over string concatenation and calls to composite formatting methods. The use of multiple string concatenation operations in the following example produces verbose and hard-to-read code.

[!code-csharp-interactive[non-interpolated string operations](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.String.Format/cs/qa-interpolated1.cs)]
[!code-vb[non-interpolated string operations](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.String.Format/vb/qa-interpolated1.vb)]
Expand Down