Skip to content

Conversation

@adamralph
Copy link
Contributor

@adamralph adamralph commented Dec 27, 2025

Summary

The built-in options do not have trailing periods:

This PR aligns the example options with the convention set by the built-in options.

I did not touch the example arguments. There are no built-in arguments, so I'm unsure of the convention.

Note that there is one example option which contains two sentences. I left that one as-is:

Copilot AI review requested due to automatic review settings December 27, 2025 11:28
@adamralph adamralph requested review from a team and gewarren as code owners December 27, 2025 11:28
@dotnetrepoman dotnetrepoman bot added this to the December 2025 milestone Dec 27, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR removes trailing periods from option descriptions in C# code examples to align with the convention established by the built-in options in System.CommandLine. The changes are limited to option descriptions only, leaving argument descriptions unchanged due to lack of built-in precedent.

Key changes:

  • Removed trailing periods from option descriptions across multiple example files
  • Preserved multi-sentence descriptions that require internal punctuation

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/standard/commandline/snippets/global-options/csharp/Program.cs Removed trailing period from quiet option description
docs/standard/commandline/snippets/define-symbols/csharp/Program.cs Removed trailing periods from delay, message, and verbosity option descriptions

@dotnet-policy-service dotnet-policy-service bot added dotnet-fundamentals/svc community-contribution Indicates PR is created by someone from the .NET community. labels Dec 27, 2025
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

Thanks @adamralph

@gewarren gewarren enabled auto-merge (squash) December 29, 2025 17:37
@gewarren gewarren merged commit a9b208a into dotnet:main Dec 29, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Indicates PR is created by someone from the .NET community. dotnet-fundamentals/svc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants