Skip to content

Fix api documentation for System/System.Numerics #8423

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

Jump to bottom
Merged
merged 28 commits into from
Sep 27, 2022
Merged

Fix api documentation for System/System.Numerics #8423

merged 28 commits into from
Sep 27, 2022

Conversation

dakersnar
Copy link
Contributor

Fixes dotnet/runtime#72410, fixes part of dotnet/runtime#72400. Also fixes a typo where APIs previously said "Tries to parses".

Should mirror the source code changes here: dotnet/runtime#76103.

dakersnar and others added 24 commits September 19, 2022 10:42
@dakersnar
Add documentation for *TryParse(TryParse(System.String,System.IFormat…
6860461 
…Provider,*)
@dakersnar
Fix parameter documentation for Decimal.Sign
3585a84
@dakersnar
Fix documentation for Type.GetEnumValuesAsUnderlyingType and Enum.Get…
d906a80 
…ValuesAsUnderlyingType
@dakersnar
Fix parameter documentation for UInt128/Int128.CompareTo
22760a7
@dakersnar
Fix documentation for UInt128/Int128.ToString
363791e
@dakersnar
Fix documentation for UInt128/Int128.Parse
b34cd79
@dakersnar
Fix documentation for UInt128/Int128.TryParse
b36b282
@dakersnar
Cleanup
1acafcf
@dakersnar @gewarren
Apply suggestions from code review
3af9e3f 
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@dakersnar @gewarren
Apply suggestions from code review
ce60f25 
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@dakersnar @gewarren
Apply suggestions from code review
faac3ac 
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@dakersnar @gewarren
Update xml/System/Enum.xml
32a0ad3 
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@dakersnar
Apply suggestions from code review for Type.xml
fc1ca15
@dakersnar
Apply suggestions from code review for Int128/UInt128
f70f6e0
@dakersnar
Apply suggestions from code review for Int128/UInt128
f73a26d
@dakersnar
Merge branch 'main' of https://github.com/dotnet/dotnet-api-docs into…
e5275ec 
… fix-runtime-72410-2
@dakersnar
Fix error with Decimal.Sign param
1d7ce76
@dakersnar
Fix documentation for System types
fa1c65d
@dakersnar
Fix BigInteger.TryParse docs
a9459a2
@dakersnar
Fix IBinaryInteger documentation
3c93df1
@dakersnar
Fix NFloat.TryParse documentation
89937dc
@dakersnar
Fix *.Item documentation issues
2cd014b
@dakersnar
Fix 'Tries to parses' typo
893c8cc
@dakersnar
Merge branch 'main' of https://github.com/dotnet/dotnet-api-docs into…
5d4041f 
… fix-runtime-72410-2
@ghost ghost assigned dakersnar Sep 23, 2022
@ghost ghost added the area-System.Numerics label Sep 23, 2022
@ghost
Copy link

ghost commented Sep 23, 2022

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

Issue Details

Fixes dotnet/runtime#72410, fixes part of dotnet/runtime#72400. Also fixes a typo where APIs previously said "Tries to parses".

Should mirror the source code changes here: dotnet/runtime#76103.

Author: dakersnar
Assignees: dakersnar
Labels:

area-System.Numerics
Milestone: -

@opbld30

This comment was marked as outdated.

Sign in to view
gewarren
gewarren approved these changes Sep 24, 2022
View reviewed changes
dakersnar and others added 2 commits September 26, 2022 11:13
@dakersnar @gewarren
Update xml/System.Numerics/Matrix3x2.xml
f1df7d4 
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@dakersnar @gewarren
Update xml/System.Numerics/Matrix4x4.xml
6a75b65 
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@opbld33

This comment was marked as outdated.

Sign in to view
@opbld30
Copy link

opbld30 commented Sep 26, 2022

Docs Build status updates of commit 6a75b65:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Numerics/BigInteger.xml 💡Suggestion View Details
xml/System/DateTime.xml 💡Suggestion View Details
xml/System/DateTimeOffset.xml 💡Suggestion View Details
xml/System/Decimal.xml 💡Suggestion View Details
xml/System/Double.xml 💡Suggestion View Details
xml/System/Guid.xml 💡Suggestion View Details
xml/System/Half.xml 💡Suggestion View Details
xml/System/Int128.xml 💡Suggestion View Details
xml/System/Single.xml 💡Suggestion View Details
xml/System/TimeOnly.xml 💡Suggestion View Details
xml/System/UInt128.xml 💡Suggestion View Details
xml/System.Numerics/INumberBase`1.xml ✅Succeeded View
xml/System.Numerics/Matrix3x2.xml ✅Succeeded View
xml/System.Numerics/Matrix4x4.xml ✅Succeeded View
xml/System.Numerics/Quaternion.xml ✅Succeeded View
xml/System.Numerics/Vector2.xml ✅Succeeded View
xml/System.Numerics/Vector3.xml ✅Succeeded View
xml/System.Numerics/Vector4.xml ✅Succeeded View
xml/System.Runtime.InteropServices/NFloat.xml ✅Succeeded View
xml/System/Byte.xml ✅Succeeded View
xml/System/DateOnly.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

This comment lists only the first 25 files in the pull request.

xml/System.Numerics/BigInteger.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Numerics.BigInteger.op_UnsignedRightShift(System.Numerics.BigInteger,System.Int32).

xml/System/DateTime.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTime.op_GreaterThan(System.DateTime,System.DateTime).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTime.op_GreaterThanOrEqual(System.DateTime,System.DateTime).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTime.op_LessThan(System.DateTime,System.DateTime).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTime.op_LessThanOrEqual(System.DateTime,System.DateTime).

xml/System/DateTimeOffset.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTimeOffset.op_GreaterThan(System.DateTimeOffset,System.DateTimeOffset).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTimeOffset.op_GreaterThanOrEqual(System.DateTimeOffset,System.DateTimeOffset).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTimeOffset.op_LessThan(System.DateTimeOffset,System.DateTimeOffset).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTimeOffset.op_LessThanOrEqual(System.DateTimeOffset,System.DateTimeOffset).

xml/System/Decimal.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Decrement(System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Division(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Equality(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_GreaterThan(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_GreaterThanOrEqual(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Increment(System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Inequality(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_LessThan(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_LessThanOrEqual(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Modulus(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Multiply(System.Decimal,System.Decimal).

xml/System/Double.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_Equality(System.Double,System.Double).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_GreaterThan(System.Double,System.Double).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_GreaterThanOrEqual(System.Double,System.Double).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_Inequality(System.Double,System.Double).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_LessThan(System.Double,System.Double).

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

carlossanlop
carlossanlop reviewed Sep 26, 2022
View reviewed changes
carlossanlop
carlossanlop reviewed Sep 26, 2022
View reviewed changes
carlossanlop
carlossanlop approved these changes Sep 26, 2022
View reviewed changes
Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

All CI suggestions are a known issue in mdoc (operators don't respect inheritdoc).

Left the two suggestions that match your PR in runtime. After they get applied, it's good to merge.

dakersnar and others added 2 commits September 26, 2022 13:19
@dakersnar @carlossanlop
Update xml/System.Numerics/Matrix3x2.xml
8e3fd8f 
Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
@dakersnar @carlossanlop
Update xml/System.Numerics/Matrix4x4.xml
ba63bba 
Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
@dakersnar
Copy link
Contributor Author

Sorry for the double commits; github won't met me batch them.

@carlossanlop
Copy link
Contributor

carlossanlop commented Sep 26, 2022 •
edited
Loading

We forgive you, @dakersnar 😄 .

Did you attempt to batch them directly here in the "Conversation" tab? Because you can't. You can only batch them in the "Files Changed" tab.

@opbld34
Copy link

opbld34 commented Sep 26, 2022

Docs Build status updates of commit 8e3fd8f:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Numerics/BigInteger.xml 💡Suggestion View Details
xml/System/DateTime.xml 💡Suggestion View Details
xml/System/DateTimeOffset.xml 💡Suggestion View Details
xml/System/Decimal.xml 💡Suggestion View Details
xml/System/Double.xml 💡Suggestion View Details
xml/System/Guid.xml 💡Suggestion View Details
xml/System/Half.xml 💡Suggestion View Details
xml/System/Int128.xml 💡Suggestion View Details
xml/System/Single.xml 💡Suggestion View Details
xml/System/TimeOnly.xml 💡Suggestion View Details
xml/System/UInt128.xml 💡Suggestion View Details
xml/System.Numerics/INumberBase`1.xml ✅Succeeded View
xml/System.Numerics/Matrix3x2.xml ✅Succeeded View
xml/System.Numerics/Matrix4x4.xml ✅Succeeded View
xml/System.Numerics/Quaternion.xml ✅Succeeded View
xml/System.Numerics/Vector2.xml ✅Succeeded View
xml/System.Numerics/Vector3.xml ✅Succeeded View
xml/System.Numerics/Vector4.xml ✅Succeeded View
xml/System.Runtime.InteropServices/NFloat.xml ✅Succeeded View
xml/System/Byte.xml ✅Succeeded View
xml/System/DateOnly.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

This comment lists only the first 25 files in the pull request.

xml/System.Numerics/BigInteger.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Numerics.BigInteger.op_UnsignedRightShift(System.Numerics.BigInteger,System.Int32).

xml/System/DateTime.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTime.op_GreaterThan(System.DateTime,System.DateTime).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTime.op_GreaterThanOrEqual(System.DateTime,System.DateTime).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTime.op_LessThan(System.DateTime,System.DateTime).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTime.op_LessThanOrEqual(System.DateTime,System.DateTime).

xml/System/DateTimeOffset.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTimeOffset.op_GreaterThan(System.DateTimeOffset,System.DateTimeOffset).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTimeOffset.op_GreaterThanOrEqual(System.DateTimeOffset,System.DateTimeOffset).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTimeOffset.op_LessThan(System.DateTimeOffset,System.DateTimeOffset).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.DateTimeOffset.op_LessThanOrEqual(System.DateTimeOffset,System.DateTimeOffset).

xml/System/Decimal.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Decrement(System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Division(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Equality(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_GreaterThan(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_GreaterThanOrEqual(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Increment(System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Inequality(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_LessThan(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_LessThanOrEqual(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Modulus(System.Decimal,System.Decimal).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Decimal.op_Multiply(System.Decimal,System.Decimal).

xml/System/Double.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_Equality(System.Double,System.Double).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_GreaterThan(System.Double,System.Double).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_GreaterThanOrEqual(System.Double,System.Double).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_Inequality(System.Double,System.Double).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NotSupportType] Inheridoc not support type: Operator for uid:System.Double.op_LessThan(System.Double,System.Double).

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@dakersnar
Copy link
Contributor Author

@carlossanlop When I went to the files tab, only one of the two suggestions showed up there. This has happened twice today on this PR and I'm not sure what is causing it. Clicking "conversations" and selecting the hidden comment just gave me nothing.

I will note that now I can see them, so I can't reproduce it.

@gewarren
Copy link
Contributor

@carlossanlop When I went to the files tab, only one of the two suggestions showed up there. This has happened twice today on this PR and I'm not sure what is causing it. Clicking "conversations" and selecting the hidden comment just gave me nothing.

Possibly you weren't looking at all commits?

@dakersnar
Copy link
Contributor Author

That's possible. If it happens again, I'll try to dig into it more.

@carlossanlop
Copy link
Contributor

The last 2 commits look good:

https://review.learn.microsoft.com/en-us/dotnet/api/system.numerics.matrix4x4.item?view=net-7.0&branch=pr-en-us-8423#exceptions
https://review.learn.microsoft.com/en-us/dotnet/api/system.numerics.matrix3x2.item?view=net-7.0&branch=pr-en-us-8423#exceptions

Since @gewarren already signed-off, and this was the only change left to verify, this is good to merge (and the runtime PR as well, assuming the changes there are identical to the ones here).

@carlossanlop carlossanlop merged commit 25b7484 into dotnet:main Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carlossanlop carlossanlop carlossanlop approved these changes

@gewarren gewarren gewarren approved these changes

@tannergooding tannergooding Awaiting requested review from tannergooding

@AaronRobinsonMSFT AaronRobinsonMSFT Awaiting requested review from AaronRobinsonMSFT AaronRobinsonMSFT is a code owner

@jkoritzinsky jkoritzinsky Awaiting requested review from jkoritzinsky jkoritzinsky is a code owner

Assignees

@dakersnar dakersnar

Labels
area-System.Numerics
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Undocumented 7.0 APIs in System.Numerics
6 participants
@dakersnar @opbld30 @opbld33 @carlossanlop @opbld34 @gewarren