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.

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

Fix up docs #4062

Merged
merged 3 commits into from
Jun 13, 2023
Merged

Fix up docs #4062

merged 3 commits into from
Jun 13, 2023

Conversation

gewarren
Copy link
Contributor

@gewarren gewarren commented Jun 11, 2023 •
edited
Loading

I made a bunch of improvements to the docs and spelling.

  • For properties, you should use <value> instead of <remarks> to provide the default value.
  • For exceptions, word it as if the sentence starts with "This exception is thrown if".

More guidance is here: https://github.com/dotnet/dotnet-api-docs/wiki

Microsoft Reviewers: Open in CodeFlow

@ghost ghost assigned gewarren Jun 11, 2023
@gewarren gewarren requested a review from RussKie June 11, 2023 01:26
@RussKie RussKie added waiting-author-feedback 📭 The author of this issue needs to respond in order for us to continue investigating this issue. documentation labels Jun 12, 2023
@ghost ghost removed the waiting-author-feedback 📭 The author of this issue needs to respond in order for us to continue investigating this issue. label Jun 12, 2023
@RussKie RussKie enabled auto-merge (squash) June 13, 2023 03:28
@RussKie RussKie merged commit b73e9c0 into main Jun 13, 2023
@RussKie RussKie deleted the docs-fixup branch June 13, 2023 03:58
@ghost ghost added this to the 8.0 Preview6 milestone Jun 13, 2023
@gewarren gewarren mentioned this pull request Jun 13, 2023
Merged
@RussKie RussKie mentioned this pull request Jun 15, 2023
Closed
@ghost ghost locked as resolved and limited conversation to collaborators Jul 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sebastienros sebastienros sebastienros left review comments

@RussKie RussKie RussKie approved these changes

@rafal-mz rafal-mz rafal-mz approved these changes

Assignees

@gewarren gewarren

Labels
documentation
Projects
None yet
Milestone
8.0 Preview6
Development

Successfully merging this pull request may close these issues.
4 participants
@gewarren @sebastienros @RussKie @rafal-mz