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

API documentation debt - System.Formats.Cbor #43858

Closed
Tracked by #43849
carlossanlop opened this issue Oct 26, 2020 · 4 comments · Fixed by #43882
Closed
Tracked by #43849

API documentation debt - System.Formats.Cbor #43858

carlossanlop opened this issue Oct 26, 2020 · 4 comments · Fixed by #43882
Assignees
Labels
area-System.Formats.Cbor documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone

Comments

@carlossanlop
Copy link
Member

carlossanlop commented Oct 26, 2020

Area owners: @eiriktsarpalis

The CborContentException type was accidentally missed it in the 5.0 effort. Please add the missing documentation directly in triple slash comments in source. We will make sure it gets ported to dotnet-api-docs after it's merged.

Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Also please add me as a PR reviewer.

Community contributions are welcome.

System.Formats.Cbor
DocId Summary Parameters TypeParameters ReturnValue
M:System.Formats.Cbor.CborContentException.#ctor(System.String,System.Exception) Missing Missing NA NA
M:System.Formats.Cbor.CborContentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext) Missing Missing NA NA
M:System.Formats.Cbor.CborContentException.#ctor(System.String) Missing Missing NA NA
T:System.Formats.Cbor.CborContentException Missing NA NA NA

The System.Formats.Cbor namespace is also missing a summary. We don't have an equivalent file in the runtime repo where this can be documented, so please add the text directly in dotnet-api-docs:
https://github.com/dotnet/dotnet-api-docs/blob/c9445d2d3a5711aea5998fde980110c14bcc1075/xml/ns-System.Formats.Cbor.xml#L3

@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors labels Oct 26, 2020
@carlossanlop carlossanlop added this to the 6.0.0 milestone Oct 26, 2020
@Dotnet-GitSync-Bot
Copy link
Collaborator

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@eiriktsarpalis
Copy link
Member

I believe the missing entries were added manually in this PR to dotnet-api-docs. If I get this correctly, this issue is about backporting dotnet-api-docs back into source?

@carlossanlop
Copy link
Member Author

carlossanlop commented Oct 27, 2020

Great! We now need to get these docs ported to dotnet-api-docs, after which we can consider this issue fixed.

@eiriktsarpalis If you want to help port them (using DocsPortingTool), that would be great. Otherwise, I can eventually do it myself.

@carlossanlop carlossanlop removed the untriaged New issue has not been triaged by the area owner label Oct 27, 2020
@carlossanlop carlossanlop self-assigned this Oct 28, 2020
@eiriktsarpalis
Copy link
Member

Fixed by #43882

@ghost ghost locked as resolved and limited conversation to collaborators Jun 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Formats.Cbor documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants