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

Undocumented 7.0 APIs in System #72409

Closed
carlossanlop opened this issue Jul 18, 2022 · 17 comments
Closed

Undocumented 7.0 APIs in System #72409

carlossanlop opened this issue Jul 18, 2022 · 17 comments
Assignees
Labels
area-System.Numerics documentation Documentation bug or enhancement, does not impact product or test code
Milestone

Comments

@carlossanlop
Copy link
Member

carlossanlop commented Jul 18, 2022

Below is the list of APIs that were introduced in 7.0 and have not yet been fully documented.

Relevant dates:

  • The last day to merge API documentation directly into triple slash comments in dotnet/runtime is before the RC1 snap on August 15th.
  • After the RC1 snap, all pending documentation changes need to be merged directly into dotnet-api-docs, and the last day to do so is before the RC2 snap on September 13th.

The latest table (Preview6) can be found in this comment.

Old table (Preview5)

@Maoni0

Class Summary Params TypeParams Returns API Docs URL
GC Missing NA NA Missing M:System.GC.GetTotalPauseDuration https://review.docs.microsoft.com/en-us/dotnet/api/System.GC.GetTotalPauseDuration?branch=main

@dotnet/area-system-globalization @tarekgh

Class Summary Params TypeParams Returns API Docs URL
TimeOnly Missing Missing NA Missing M:System.TimeOnly.TryParse(System.String,System.IFormatProvider,System.TimeOnly@) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.TryParse?branch=main
TimeOnly Present Missing NA Present M:System.TimeOnly.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.Parse?branch=main
TimeOnly Present Missing NA Present M:System.TimeOnly.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.TimeOnly@) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.TryParse?branch=main

@dotnet/area-system-runtime @stephentoub

Class Summary Params TypeParams Returns API Docs URL
ObjectDisposedException Missing Missing NA NA M:System.ObjectDisposedException.ThrowIf(System.Boolean,System.Type) https://review.docs.microsoft.com/en-us/dotnet/api/System.ObjectDisposedException.ThrowIf?branch=main
ObjectDisposedException Missing Missing NA NA M:System.ObjectDisposedException.ThrowIf(System.Boolean,System.Object) https://review.docs.microsoft.com/en-us/dotnet/api/System.ObjectDisposedException.ThrowIf?branch=main
Class Summary Params TypeParams Returns API Docs URL
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code area-System.Globalization area-System.Runtime area-GC-coreclr labels Jul 18, 2022
@carlossanlop carlossanlop added this to the 7.0.0 milestone Jul 18, 2022
@ghost
Copy link

ghost commented Jul 18, 2022

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

Issue Details

Below is the list of APIs that were introduced in 7.0 and have not yet been fully documented.

Relevant dates:

  • The last day to merge API documentation directly into triple slash comments in dotnet/runtime is before the RC1 snap on August 15th.
  • After the RC1 snap, all pending documentation changes need to be merged directly into dotnet-api-docs, and the last day to do so is before the RC2 snap on September 13th.

@Maoni0

Class Summary Params TypeParams Returns API Docs URL
GC Missing NA NA Missing M:System.GC.GetTotalPauseDuration https://review.docs.microsoft.com/en-us/dotnet/api/System.GC.GetTotalPauseDuration?branch=main

@dotnet/area-system-globalization @tarekgh

Class Summary Params TypeParams Returns API Docs URL
TimeOnly Missing Missing NA Missing M:System.TimeOnly.TryParse(System.String,System.IFormatProvider,System.TimeOnly@) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.TryParse?branch=main
TimeOnly Present Missing NA Present M:System.TimeOnly.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.Parse?branch=main
TimeOnly Present Missing NA Present M:System.TimeOnly.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.TimeOnly@) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.TryParse?branch=main

@dotnet/area-system-runtime @stephentoub

Class Summary Params TypeParams Returns API Docs URL
ObjectDisposedException Missing Missing NA NA M:System.ObjectDisposedException.ThrowIf(System.Boolean,System.Type) https://review.docs.microsoft.com/en-us/dotnet/api/System.ObjectDisposedException.ThrowIf?branch=main
ObjectDisposedException Missing Missing NA NA M:System.ObjectDisposedException.ThrowIf(System.Boolean,System.Object) https://review.docs.microsoft.com/en-us/dotnet/api/System.ObjectDisposedException.ThrowIf?branch=main
Class Summary Params TypeParams Returns API Docs URL
Author: carlossanlop
Assignees: -
Labels:

documentation, area-System.Globalization, area-System.Runtime, area-GC-coreclr

Milestone: 7.0.0

@ghost
Copy link

ghost commented Jul 18, 2022

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

Issue Details

Below is the list of APIs that were introduced in 7.0 and have not yet been fully documented.

Relevant dates:

  • The last day to merge API documentation directly into triple slash comments in dotnet/runtime is before the RC1 snap on August 15th.
  • After the RC1 snap, all pending documentation changes need to be merged directly into dotnet-api-docs, and the last day to do so is before the RC2 snap on September 13th.

@Maoni0

Class Summary Params TypeParams Returns API Docs URL
GC Missing NA NA Missing M:System.GC.GetTotalPauseDuration https://review.docs.microsoft.com/en-us/dotnet/api/System.GC.GetTotalPauseDuration?branch=main

@dotnet/area-system-globalization @tarekgh

Class Summary Params TypeParams Returns API Docs URL
TimeOnly Missing Missing NA Missing M:System.TimeOnly.TryParse(System.String,System.IFormatProvider,System.TimeOnly@) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.TryParse?branch=main
TimeOnly Present Missing NA Present M:System.TimeOnly.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.Parse?branch=main
TimeOnly Present Missing NA Present M:System.TimeOnly.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.TimeOnly@) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.TryParse?branch=main

@dotnet/area-system-runtime @stephentoub

Class Summary Params TypeParams Returns API Docs URL
ObjectDisposedException Missing Missing NA NA M:System.ObjectDisposedException.ThrowIf(System.Boolean,System.Type) https://review.docs.microsoft.com/en-us/dotnet/api/System.ObjectDisposedException.ThrowIf?branch=main
ObjectDisposedException Missing Missing NA NA M:System.ObjectDisposedException.ThrowIf(System.Boolean,System.Object) https://review.docs.microsoft.com/en-us/dotnet/api/System.ObjectDisposedException.ThrowIf?branch=main
Class Summary Params TypeParams Returns API Docs URL
Author: carlossanlop
Assignees: -
Labels:

documentation, area-System.Globalization, area-System.Runtime, area-GC-coreclr

Milestone: 7.0.0

@Maoni0
Copy link
Member

Maoni0 commented Jul 18, 2022

@cshung could you add the required material please?

@mrsharm
Copy link
Member

mrsharm commented Jul 18, 2022

@carlossanlop @Maoni0, I see that the System.GC.GetConfigurationVariables is missing in this list. We added this method recently via #70514 where I believe I moved the doc string of GetTotalPauseDuration here (for consistency). Could it be possible the tool you are using to pick up the changes aren't up to date?

@carlossanlop
Copy link
Member Author

The above list is based on the latest released preview that we are showing in MS Docs. That would be Preview5:

I will update the list as soon as I have the Preview6 APIs transferred to MS Docs.

@tarekgh
Copy link
Member

tarekgh commented Jul 19, 2022

TimeOnly issues are fixed by the PR dotnet/dotnet-api-docs#8229

@tannergooding
Copy link
Member

The ObjectDisposedException.ThrowIf APIs have existing XML doc comments. Can we port them over and then rerun the tooling that flags any actually missing documentation?

@stephentoub
Copy link
Member

The ObjectDisposedException.ThrowIf APIs have existing XML doc comments. Can we port them over and then rerun the tooling that flags any actually missing documentation?

Those got added this week in #72411 in response to Carlos reporting them missing.

@carlossanlop
Copy link
Member Author

carlossanlop commented Aug 10, 2022

I generated the report again today. It now includes APIs introduced all the way until Preview6 (the original list included APIs introduced until Preview5).

I'll update the main description to point to this comment.

@Maoni0 @cshung

GC
Summary Parameters TypeParameters ReturnValue API
Missing NA NA NA F:System.GCCollectionMode.Aggressive

@dotnet/area-system-globalization

Globalization
Summary Parameters TypeParameters ReturnValue API
Present Missing NA Present M:System.DateOnly.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider)
Present Missing NA Present M:System.DateOnly.Parse(System.String,System.IFormatProvider)
Present Missing NA Present M:System.DateOnly.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.DateOnly@)
Present Missing NA Present M:System.DateOnly.TryParse(System.String,System.IFormatProvider,System.DateOnly@)
Present Missing NA Present M:System.DateTime.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider)
Present Missing NA Present M:System.DateTime.TryParse(System.String,System.IFormatProvider,System.DateTime@)
Present Missing NA Present M:System.DateTime.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.DateTime@)
Present Missing NA Present M:System.DateTimeOffset.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider)
Present Missing NA Present M:System.DateTimeOffset.TryParse(System.String,System.IFormatProvider,System.DateTimeOffset@)
Present Missing NA Present M:System.DateTimeOffset.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.DateTimeOffset@)

@dotnet/area-system-runtime

System.Runtime
Summary Parameters TypeParameters ReturnValue API
Present Missing NA Present M:System.Guid.op_GreaterThan(System.Guid,System.Guid)
Present Missing NA Present M:System.Guid.op_GreaterThanOrEqual(System.Guid,System.Guid)
Present Missing NA Present M:System.Guid.op_LessThan(System.Guid,System.Guid)
Present Missing NA Present M:System.Guid.op_LessThanOrEqual(System.Guid,System.Guid)
Present Missing NA Present M:System.Guid.Parse(System.String,System.IFormatProvider)
Present Missing NA Present M:System.Guid.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider)
Present Missing NA Present M:System.Guid.TryParse(System.String,System.IFormatProvider,System.Guid@)
Present Missing NA Present M:System.Guid.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.Guid@)

Numerics APIs can be found in #72410

@carlossanlop carlossanlop added the untriaged New issue has not been triaged by the area owner label Aug 10, 2022
@cshung
Copy link
Member

cshung commented Aug 10, 2022

@carlossanlop, will #73725 fix it?

@tarekgh
Copy link
Member

tarekgh commented Aug 10, 2022

@carlossanlop for the globalization APIs, looks are marked with the inhirited tag. why the tool didn't handle that? here are some examples:

/// <inheritdoc cref="ISpanParsable{TSelf}.Parse(ReadOnlySpan{char}, IFormatProvider?)" />

/// <inheritdoc cref="IParsable{TSelf}.Parse(string, IFormatProvider?)" />

/// <inheritdoc cref="ISpanParsable{TSelf}.TryParse(ReadOnlySpan{char}, IFormatProvider?, out TSelf)" />

/// <inheritdoc cref="IParsable{TSelf}.TryParse(string?, IFormatProvider?, out TSelf)" />

@jeffhandley jeffhandley removed the untriaged New issue has not been triaged by the area owner label Aug 11, 2022
@tarekgh
Copy link
Member

tarekgh commented Aug 11, 2022

@carlossanlop the following APIs are marked with inheritdoc tag. So when you fix the tool this should be automatically handled.

M:System.TimeOnly.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider)
M:System.TimeOnly.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.TimeOnly@)

For M:System.TimeOnly.TryParse(System.String,System.IFormatProvider,System.TimeOnly@)
This should be same, but the source file is missing the inheritdoc. I'll submit a PR to fix it on the source. will the tool be able to pick the change after I merge such PR? I'll tag you on this PR.

@tarekgh
Copy link
Member

tarekgh commented Aug 11, 2022

I opened the PR to add the missing doc tags to the sources.

@carlossanlop
Copy link
Member Author

will the tool be able to pick the change after I merge such PR? I'll tag you on this PR.

@tarekgh If the dotnet-api-docs item has the boilerplate message To be added. then yes, the tool will be able to port it for you. Otherwise, you'll have to make the change directly in dotnet-api-docs.

@carlossanlop
Copy link
Member Author

Hello all, thanks for your patience. I have the latest list of undoc APIs as of Preview7, and having ported all I could find in main from the PRs you all mentioned above.

@cshung @tarekgh @stephentoub We are good 👍🏼 with GC, ObjectDisposedException and Globalization. Thanks!

@tannergooding @dakersnar we still have some partially undocumented APIs related to Numerics. I did fix the <inheritdoc/> issue in the porting tool, so all the APIs that were decorated with it, should not show in the report anymore (here's the PR that ported the tag). Can you please check what these APIs are missing and document them directly in dotnet-api-docs?

API Summary Parameters TypeParameters ReturnValue
M:System.Decimal.Sign(System.Decimal) Present Missing NA Present
M:System.Decimal.TryParse(System.String,System.IFormatProvider,System.Decimal@) Missing Missing NA Missing
M:System.Double.TryParse(System.String,System.IFormatProvider,System.Double@) Missing Missing NA Missing
M:System.Guid.op_GreaterThan(System.Guid,System.Guid) Present Missing NA Present
M:System.Guid.op_GreaterThanOrEqual(System.Guid,System.Guid) Present Missing NA Present
M:System.Guid.op_LessThan(System.Guid,System.Guid) Present Missing NA Present
M:System.Guid.op_LessThanOrEqual(System.Guid,System.Guid) Present Missing NA Present
M:System.Half.op_Addition(System.Half,System.Half) Present Missing NA Present
M:System.Half.op_CheckedExplicit(System.Half) Missing Missing NA Missing
M:System.Half.op_Decrement(System.Half) Present Missing NA Present
M:System.Half.op_Division(System.Half,System.Half) Present Missing NA Present
M:System.Half.op_Increment(System.Half) Present Missing NA Present
M:System.Half.op_Modulus(System.Half,System.Half) Present Missing NA Present
M:System.Half.op_Multiply(System.Half,System.Half) Present Missing NA Present
M:System.Half.op_Subtraction(System.Half,System.Half) Present Missing NA Present
M:System.Half.op_UnaryNegation(System.Half) Present Missing NA Present
M:System.Half.op_UnaryPlus(System.Half) Present Missing NA Present
M:System.Half.TryParse(System.String,System.IFormatProvider,System.Half@) Missing Missing NA Missing
M:System.Int128.CompareTo(System.Int128) Present Missing NA Present
M:System.Int128.CompareTo(System.Object) Present Missing NA Present
M:System.Int128.op_Addition(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_BitwiseAnd(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_BitwiseOr(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_CheckedAddition(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_CheckedDecrement(System.Int128) Present Missing NA Present
M:System.Int128.op_CheckedDivision(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_CheckedExplicit(System.Single) Missing Missing NA Missing
M:System.Int128.op_CheckedExplicit(System.Double) Missing Missing NA Missing
M:System.Int128.op_CheckedExplicit(System.Int128) Missing Missing NA Missing
M:System.Int128.op_CheckedIncrement(System.Int128) Present Missing NA Present
M:System.Int128.op_CheckedMultiply(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_CheckedSubtraction(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_CheckedUnaryNegation(System.Int128) Present Missing NA Present
M:System.Int128.op_Decrement(System.Int128) Present Missing NA Present
M:System.Int128.op_Division(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_Equality(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_ExclusiveOr(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_GreaterThan(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_GreaterThanOrEqual(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_Increment(System.Int128) Present Missing NA Present
M:System.Int128.op_Inequality(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_LeftShift(System.Int128,System.Int32) Present Missing NA Present
M:System.Int128.op_LessThan(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_LessThanOrEqual(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_Modulus(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_Multiply(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_OnesComplement(System.Int128) Present Missing NA Present
M:System.Int128.op_RightShift(System.Int128,System.Int32) Present Missing NA Present
M:System.Int128.op_Subtraction(System.Int128,System.Int128) Present Missing NA Present
M:System.Int128.op_UnaryNegation(System.Int128) Present Missing NA Present
M:System.Int128.op_UnaryPlus(System.Int128) Present Missing NA Present
M:System.Int128.op_UnsignedRightShift(System.Int128,System.Int32) Present Missing NA Present
M:System.Int128.Parse(System.String) Missing Missing NA Missing
M:System.Int128.Parse(System.String,System.Globalization.NumberStyles) Missing Missing NA Missing
M:System.Int128.Parse(System.ReadOnlySpan{System.Char},System.Globalization.NumberStyles,System.IFormatProvider) Missing Missing NA Missing
M:System.Int128.ToString(System.IFormatProvider) Missing Missing NA Missing
M:System.Int128.ToString(System.String) Missing Missing NA Missing
M:System.Int128.ToString(System.String,System.IFormatProvider) Present Missing NA Present
M:System.Int128.TryFormat(System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider) Missing Missing NA Missing
M:System.Int128.TryParse(System.String,System.Int128@) Missing Missing NA Missing
M:System.Int128.TryParse(System.ReadOnlySpan{System.Char},System.Globalization.NumberStyles,System.IFormatProvider,System.Int128@) Missing Missing NA Missing
M:System.Int128.TryParse(System.String,System.Globalization.NumberStyles,System.IFormatProvider,System.Int128@) Missing Missing NA Missing
M:System.Int128.TryParse(System.String,System.IFormatProvider,System.Int128@) Missing Missing NA Missing
M:System.Int128.TryParse(System.ReadOnlySpan{System.Char},System.Int128@) Missing Missing NA Missing
M:System.Int16.TryParse(System.String,System.IFormatProvider,System.Int16@) Missing Missing NA Missing
M:System.Int32.TryParse(System.String,System.IFormatProvider,System.Int32@) Missing Missing NA Missing
M:System.Int64.TryParse(System.String,System.IFormatProvider,System.Int64@) Missing Missing NA Missing
M:System.IntPtr.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider) Missing Missing NA Missing
M:System.IntPtr.TryParse(System.String,System.IFormatProvider,System.IntPtr@) Missing Missing NA Missing
M:System.IntPtr.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.IntPtr@) Missing Missing NA Missing
M:System.SByte.TryParse(System.String,System.IFormatProvider,System.SByte@) Missing Missing NA Missing
M:System.Single.TryParse(System.String,System.IFormatProvider,System.Single@) Missing Missing NA Missing
M:System.UInt128.CompareTo(System.Object) Present Missing NA Present
M:System.UInt128.CompareTo(System.UInt128) Present Missing NA Present
M:System.UInt128.op_Addition(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_BitwiseAnd(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_BitwiseOr(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_CheckedAddition(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_CheckedDecrement(System.UInt128) Present Missing NA Present
M:System.UInt128.op_CheckedDivision(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_CheckedExplicit(System.Double) Missing Missing NA Missing
M:System.UInt128.op_CheckedExplicit(System.Int16) Missing Missing NA Missing
M:System.UInt128.op_CheckedExplicit(System.Int32) Missing Missing NA Missing
M:System.UInt128.op_CheckedExplicit(System.Int64) Missing Missing NA Missing
M:System.UInt128.op_CheckedExplicit(System.IntPtr) Missing Missing NA Missing
M:System.UInt128.op_CheckedExplicit(System.SByte) Missing Missing NA Missing
M:System.UInt128.op_CheckedExplicit(System.Single) Missing Missing NA Missing
M:System.UInt128.op_CheckedExplicit(System.UInt128) Missing Missing NA Missing
M:System.UInt128.op_CheckedIncrement(System.UInt128) Present Missing NA Present
M:System.UInt128.op_CheckedMultiply(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_CheckedSubtraction(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_CheckedUnaryNegation(System.UInt128) Present Missing NA Present
M:System.UInt128.op_Decrement(System.UInt128) Present Missing NA Present
M:System.UInt128.op_Division(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_Equality(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_ExclusiveOr(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_GreaterThan(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_GreaterThanOrEqual(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_Increment(System.UInt128) Present Missing NA Present
M:System.UInt128.op_Inequality(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_LeftShift(System.UInt128,System.Int32) Present Missing NA Present
M:System.UInt128.op_LessThan(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_LessThanOrEqual(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_Modulus(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_Multiply(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_OnesComplement(System.UInt128) Present Missing NA Present
M:System.UInt128.op_RightShift(System.UInt128,System.Int32) Present Missing NA Present
M:System.UInt128.op_Subtraction(System.UInt128,System.UInt128) Present Missing NA Present
M:System.UInt128.op_UnaryNegation(System.UInt128) Present Missing NA Present
M:System.UInt128.op_UnaryPlus(System.UInt128) Present Missing NA Present
M:System.UInt128.op_UnsignedRightShift(System.UInt128,System.Int32) Present Missing NA Present
M:System.UInt128.Parse(System.String) Missing Missing NA Missing
M:System.UInt128.Parse(System.ReadOnlySpan{System.Char},System.Globalization.NumberStyles,System.IFormatProvider) Missing Missing NA Missing
M:System.UInt128.Parse(System.String,System.Globalization.NumberStyles) Missing Missing NA Missing
M:System.UInt128.ToString(System.IFormatProvider) Missing Missing NA Missing
M:System.UInt128.ToString(System.String,System.IFormatProvider) Present Missing NA Present
M:System.UInt128.ToString(System.String) Missing Missing NA Missing
M:System.UInt128.TryFormat(System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider) Missing Missing NA Missing
M:System.UInt128.TryParse(System.String,System.UInt128@) Missing Missing NA Missing
M:System.UInt128.TryParse(System.ReadOnlySpan{System.Char},System.UInt128@) Missing Missing NA Missing
M:System.UInt128.TryParse(System.String,System.Globalization.NumberStyles,System.IFormatProvider,System.UInt128@) Missing Missing NA Missing
M:System.UInt128.TryParse(System.ReadOnlySpan{System.Char},System.Globalization.NumberStyles,System.IFormatProvider,System.UInt128@) Missing Missing NA Missing
M:System.UInt128.TryParse(System.String,System.IFormatProvider,System.UInt128@) Missing Missing NA Missing
M:System.UInt16.TryParse(System.String,System.IFormatProvider,System.UInt16@) Missing Missing NA Missing
M:System.UInt32.TryParse(System.String,System.IFormatProvider,System.UInt32@) Missing Missing NA Missing
M:System.UInt64.TryParse(System.String,System.IFormatProvider,System.UInt64@) Missing Missing NA Missing
M:System.UIntPtr.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider) Missing Missing NA Missing
M:System.UIntPtr.TryParse(System.String,System.IFormatProvider,System.UIntPtr@) Missing Missing NA Missing
M:System.UIntPtr.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.UIntPtr@) Missing Missing NA Missing

@ghost
Copy link

ghost commented Aug 29, 2022

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

Issue Details

Below is the list of APIs that were introduced in 7.0 and have not yet been fully documented.

Relevant dates:

  • The last day to merge API documentation directly into triple slash comments in dotnet/runtime is before the RC1 snap on August 15th.
  • After the RC1 snap, all pending documentation changes need to be merged directly into dotnet-api-docs, and the last day to do so is before the RC2 snap on September 13th.

The latest table (Preview6) can be found in this comment.

Old table (Preview5)

@Maoni0

Class Summary Params TypeParams Returns API Docs URL
GC Missing NA NA Missing M:System.GC.GetTotalPauseDuration https://review.docs.microsoft.com/en-us/dotnet/api/System.GC.GetTotalPauseDuration?branch=main

@dotnet/area-system-globalization @tarekgh

Class Summary Params TypeParams Returns API Docs URL
TimeOnly Missing Missing NA Missing M:System.TimeOnly.TryParse(System.String,System.IFormatProvider,System.TimeOnly@) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.TryParse?branch=main
TimeOnly Present Missing NA Present M:System.TimeOnly.Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.Parse?branch=main
TimeOnly Present Missing NA Present M:System.TimeOnly.TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.TimeOnly@) https://review.docs.microsoft.com/en-us/dotnet/api/System.TimeOnly.TryParse?branch=main

@dotnet/area-system-runtime @stephentoub

Class Summary Params TypeParams Returns API Docs URL
ObjectDisposedException Missing Missing NA NA M:System.ObjectDisposedException.ThrowIf(System.Boolean,System.Type) https://review.docs.microsoft.com/en-us/dotnet/api/System.ObjectDisposedException.ThrowIf?branch=main
ObjectDisposedException Missing Missing NA NA M:System.ObjectDisposedException.ThrowIf(System.Boolean,System.Object) https://review.docs.microsoft.com/en-us/dotnet/api/System.ObjectDisposedException.ThrowIf?branch=main
Class Summary Params TypeParams Returns API Docs URL
Author: carlossanlop
Assignees: -
Labels:

documentation, area-System.Numerics

Milestone: 7.0.0

@carlossanlop
Copy link
Member Author

I'm going to close this issue in favor of the Numerics one. All the APIs with missing docs in System belong to that area. #72410 (comment)

@ghost ghost locked as resolved and limited conversation to collaborators Oct 15, 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

10 participants