-
Notifications
You must be signed in to change notification settings - Fork 6k
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
Improve System.MidpointRounding documentation #19314
Comments
Here's the API doc: https://docs.microsoft.com/en-us/dotnet/api/system.midpointrounding?view=netcore-3.1. @SingleAccretion If you want to work on this, that's great! After you submit a pull request, the technical experts will review it. |
@gewarren Great, I have started working on it. |
The enum summary should also be fixed as it currently says:
Which has caused some confusion for users of my |
The problem
Rounding of floating point numbers is often considered one of the less intuitive .NET APIs. This makes good documentation in this area a necessity. Unfortunately, recent additions to the API surface of
System.MidpointRounding
do not enjoy the treatment of the thorough explanation that their existing counterparts have.Right now, if I look at the table in the docs, these are the descriptions of the various rounding modes:
There are a couple of problems with this table:
This is my biggest problem with the doc, but it is not the only one. After the table there is a detailed section on the first two modes and what they do but there is nothing for the other modes.
This issue is a follow up to #38160.
Suggestions
My suggestions would be to:
I would like to contribute the improvements listed above, but there is a problem: I am not a domain expert. I can read the relevant part if the IEEE spec, but it is not a guarantee I will interpret it correctly. Is that acceptable given the history/sensitivity of the APIs in question?
The text was updated successfully, but these errors were encountered: