-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Port System new docs (second pass) #10213
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
Conversation
Tagging subscribers to this area: @dotnet/area-system-runtime |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
@@ -1946,7 +1946,7 @@ Euler's number is approximately 2.7182818284590452354. | |||
<Parameter Name="x" Type="System.Double" Index="0" FrameworkAlternate="net-7.0;net-8.0;net-9.0" /> | |||
</Parameters> | |||
<Docs> | |||
<param name="x">The power to which <code data-dev-comment-type="c">E</code> is raised.</param> | |||
<param name="x">The power to which <c>E</c> is raised.</param> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think I've ever encountered e in captial when referrring to Euler's number. The wiki URL has it that way, but the entirety of the text refers to it in italicized lower-case - https://en.wikipedia.org/wiki/E_(mathematical_constant).
Looks like Wolfram does use E
in Mathematica, so perhaps that is prior art to copy here. Just curious if this was discussed.
@tannergooding Was this an intentional choice?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd have expected this to have been a cref="E"
so it refers to the named constant we use for Euler's number
.
I know we have some support for LaTeX
now, so if we're not doing a cref, then maybe using the "proper" math symbol is better?
CC. @gewarren
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I see. If this was referring to the .NET name, then that makes sense to me.
Some APIs were missed in the first pass.
Contributes to dotnet/runtime#105987