Skip to content

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

Merged
merged 7 commits into from
Aug 8, 2024
Merged

Conversation

carlossanlop
Copy link
Contributor

Some APIs were missed in the first pass.

Contributes to dotnet/runtime#105987

@carlossanlop carlossanlop requested a review from a team as a code owner August 6, 2024 23:07
@carlossanlop carlossanlop requested review from a team and tannergooding August 6, 2024 23:07
@ghost ghost added the area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. label Aug 6, 2024
@carlossanlop carlossanlop requested a review from gewarren August 6, 2024 23:08
@carlossanlop carlossanlop self-assigned this Aug 6, 2024
@carlossanlop carlossanlop added area-System.Runtime and removed area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. labels Aug 6, 2024
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-system-runtime

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>
Copy link
Member

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?

Copy link
Member

@tannergooding tannergooding Aug 21, 2024

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

Copy link
Member

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.

This comment was marked as outdated.

@carlossanlop carlossanlop enabled auto-merge (squash) August 8, 2024 04:34
@carlossanlop carlossanlop disabled auto-merge August 8, 2024 04:35
@carlossanlop carlossanlop enabled auto-merge (squash) August 8, 2024 04:35
Copy link

Learn Build status updates of commit ba0dabe:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Runtime.InteropServices/NFloat.xml ✅Succeeded View
xml/System/Char.xml ✅Succeeded View
xml/System/DateOnly.xml ✅Succeeded View
xml/System/DateTimeOffset.xml ✅Succeeded View
xml/System/Decimal.xml ✅Succeeded View
xml/System/Double.xml ✅Succeeded View
xml/System/Guid.xml ✅Succeeded View
xml/System/Half.xml ✅Succeeded View
xml/System/Int128.xml ✅Succeeded View
xml/System/Int16.xml ✅Succeeded View
xml/System/Int32.xml ✅Succeeded View
xml/System/Int64.xml ✅Succeeded View
xml/System/IntPtr.xml ✅Succeeded View
xml/System/MemoryExtensions.xml ✅Succeeded View
xml/System/SByte.xml ✅Succeeded View
xml/System/Single.xml ✅Succeeded View
xml/System/TimeOnly.xml ✅Succeeded View
xml/System/TimeSpan.xml ✅Succeeded View
xml/System/UInt128.xml ✅Succeeded View
xml/System/UInt16.xml ✅Succeeded View
xml/System/UInt32.xml ✅Succeeded View
xml/System/UInt64.xml ✅Succeeded View
xml/System/UIntPtr.xml ✅Succeeded View
xml/System/Version.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@carlossanlop carlossanlop merged commit e53f388 into dotnet:main Aug 8, 2024
3 checks passed
@carlossanlop carlossanlop deleted the PortSystem branch August 8, 2024 04:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants