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.ComponentModel #73724

Closed
carlossanlop opened this issue Aug 10, 2022 · 8 comments · Fixed by dotnet/dotnet-api-docs#8425
Closed

Undocumented 7.0 APIs in System.ComponentModel #73724

carlossanlop opened this issue Aug 10, 2022 · 8 comments · Fixed by dotnet/dotnet-api-docs#8425
Assignees
Labels
area-System.ComponentModel documentation Documentation bug or enhancement, does not impact product or test code
Milestone

Comments

@carlossanlop
Copy link
Member

@dotnet/area-system-componentmodel

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.

Undocumented System.ComponentModel APIs as of Preview6

Summary Parameters TypeParameters ReturnValue API
Present Missing NA Present M:System.ComponentModel.DateOnlyConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)
Missing NA NA NA M:System.ComponentModel.HalfConverter.#ctor
Missing NA NA NA M:System.ComponentModel.Int128Converter.#ctor
Present Missing NA Present M:System.ComponentModel.TimeOnlyConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)
Missing NA NA NA M:System.ComponentModel.UInt128Converter.#ctor
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code area-System.ComponentModel labels Aug 10, 2022
@carlossanlop carlossanlop added this to the 7.0.0 milestone Aug 10, 2022
@ghost
Copy link

ghost commented Aug 10, 2022

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

Issue Details

@dotnet/area-system-componentmodel

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.

Undocumented System.ComponentModel APIs as of Preview6

Summary Parameters TypeParameters ReturnValue API
Present Missing NA Present M:System.ComponentModel.DateOnlyConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)
Missing NA NA NA M:System.ComponentModel.HalfConverter.#ctor
Missing NA NA NA M:System.ComponentModel.Int128Converter.#ctor
Present Missing NA Present M:System.ComponentModel.TimeOnlyConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)
Missing NA NA NA M:System.ComponentModel.UInt128Converter.#ctor
Author: carlossanlop
Assignees: -
Labels:

documentation, area-System.ComponentModel

Milestone: 7.0.0

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

tarekgh commented Aug 10, 2022

@carlossanlop this is again issue with the tool that doesn't handle the /// <inheritdoc /> tag from the sources.

@jeffschwMSFT jeffschwMSFT 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

@tarekgh tarekgh added the needs-author-action An issue or pull request that requires more info or actions from the author. label Aug 11, 2022
@ghost
Copy link

ghost commented Aug 11, 2022

This issue has been marked needs-author-action and may be missing some important information.

@carlossanlop
Copy link
Member Author

Acknowledged. I'll close it. If I see any other APIs, I'll open a new issue.

@ghost ghost locked as resolved and limited conversation to collaborators Sep 15, 2022
@ericstj
Copy link
Member

ericstj commented Sep 23, 2022

Looks like the tool has a bug where it doesn't port docs for the implicit parameterless constructor. We might need to manually doc these to get it in for 7.0.

@tarekgh tarekgh reopened this Sep 23, 2022
@tarekgh
Copy link
Member

tarekgh commented Sep 23, 2022

reopen to handle the parameterless constructor cases.

@carlossanlop
Copy link
Member Author

Issue opened to fix the parameterless constructor case in the porting tool in the future: dotnet/api-docs-sync#132

@ghost ghost added needs-further-triage Issue has been initially triaged, but needs deeper consideration or reconsideration and removed needs-author-action An issue or pull request that requires more info or actions from the author. labels Sep 23, 2022
@tarekgh tarekgh removed the needs-further-triage Issue has been initially triaged, but needs deeper consideration or reconsideration label Sep 23, 2022
@Nick-Stanton Nick-Stanton self-assigned this Sep 23, 2022
@tarekgh tarekgh closed this as completed Sep 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.ComponentModel documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants