Skip to content
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

Update the XML docs for IComparisonOperators and implementing types #64463

Closed
Tracked by #47244
tannergooding opened this issue Jan 28, 2022 · 3 comments
Closed
Tracked by #47244
Assignees
Labels
area-System.Numerics documentation Documentation bug or enhancement, does not impact product or test code
Milestone

Comments

@tannergooding
Copy link
Member

As called out in #64234 (comment)

The current XML docs for the IComparisonOperators operators are potentially confusing as they are:

///

Compares two values to determine which is less.

We should likely update this to something like

///

Returns a value that indicates whether a specified TSelf value is less than or equal to another specified TOther value.

and then update the docs of things like NFloat and the other types that are implementing, or will implement, IComparisonOperators accordingly.

@dotnet-issue-labeler dotnet-issue-labeler bot added the untriaged New issue has not been triaged by the area owner label Jan 28, 2022
@dotnet-issue-labeler
Copy link

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@tannergooding tannergooding added this to the 7.0.0 milestone Jan 28, 2022
@tannergooding tannergooding self-assigned this Jan 28, 2022
@tannergooding tannergooding added area-System.Numerics documentation Documentation bug or enhancement, does not impact product or test code and removed untriaged New issue has not been triaged by the area owner labels Jan 28, 2022
@ghost
Copy link

ghost commented Jan 28, 2022

Tagging subscribers to this area: @dotnet/area-system-numerics
See info in area-owners.md if you want to be subscribed.

Issue Details

As called out in #64234 (comment)

The current XML docs for the IComparisonOperators operators are potentially confusing as they are:

///

Compares two values to determine which is less.

We should likely update this to something like

///

Returns a value that indicates whether a specified TSelf value is less than or equal to another specified TOther value.

and then update the docs of things like NFloat and the other types that are implementing, or will implement, IComparisonOperators accordingly.

Author: tannergooding
Assignees: tannergooding
Labels:

documentation, area-System.Numerics

Milestone: 7.0.0

@dakersnar
Copy link
Contributor

Closed as a dup of #69694

@ghost ghost locked as resolved and limited conversation to collaborators Sep 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Numerics documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Development

No branches or pull requests

2 participants