8000 Automatic port of Rune.CompareTo EII by carlossanlop · Pull Request #4891 · dotnet/dotnet-api-docs · GitHub
[go: up one dir, main page]
Skip to content

Automatic port of Rune.CompareTo EII #4891

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
Sep 22, 2020
Merged

Automatic port of Rune.CompareTo EII #4891

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
18 changes: 14 additions & 4 deletions xml/System.Text/Rune.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1694,10 +1694,20 @@ For more information, see <xref:System.Char.IsWhiteSpace%2A?displayProperty=name
<Parameter Name="obj" Type="System.Object" Index="0" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="other">The object to compare with the current instance.</param>
<summary>Compares the current instance to the specified object.</summary>
Copy link

Choose a reason for hiding this comment

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

I wonder if /// <inheritdoc> works here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It probably does work, but I found a bug in the tool that made it crash when encountering a special character. So I transcribed it manually.

<returns>A signed integer indicating the position of this instance in the sort order in relation to <paramref name="other" />: <br />- Less than zero: This instance precedes <paramref name="other" />.
Copy link

Choose a reason for hiding this comment

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

Maybe consider re-wording this similar to https://docs.microsoft.com/en-us/dotnet/api/system.single.compareto?view=netcore-3.1#System_Single_CompareTo_System_Object_ ?

<br />- Zero: The instance has the same position in the sort order as <paramref name="other" />.
<br />- Greater than zero: This instance follows <paramref name="other" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Text.Rune> instance is cast to an <xref:System.IComparable> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToLower">
Expand Down
0