-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Continue adding version include #51195
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
base: main
Are you sure you want to change the base?
Conversation
Contributes to dotnet#50891 Commit by commit: - C# Guide root.
Add the new include file, perform a general edit and freshness pass.
1bafb86 to
27227c6
Compare
Add the include file in all files in the Statements folder. Perform a general edit and freshness pass.
There was a problem hiding this 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 continues the work of adding version include notes to C# documentation files. The changes focus on two main areas: the C# Guide root folder and the XMLDocs folder. The PR adds the [!INCLUDE[csharp-version-note](../includes/initial-version.md)] directive to all modified files and makes numerous style improvements to align with the Microsoft documentation guidelines.
Changes:
- Added version include notes to 17 C# language reference documentation files
- Updated dates across all files to reflect current or near-current dates
- Improved writing style throughout to use active voice, imperative mood, and second person ("you")
- Enhanced clarity and readability by converting passive constructions to active ones
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| recommended-tags.md | Added version note; improved style with active voice and imperative mood throughout XML tag documentation |
| index.md | Added version note; enhanced clarity in XML documentation comments overview |
| examples.md | Added version note; refined language for XML documentation examples |
| unsafe-code.md | Added version note; improved explanations of unsafe code, pointers, and function pointers |
| yield.md | Added version note; clarified yield statement usage in iterators |
| using.md | Added version note; improved using statement documentation |
| selection-statements.md | Added version note; enhanced if/switch statement explanations |
| lock.md | Added version note; clarified lock statement behavior |
| jump-statements.md | Added version note; improved jump statement documentation |
| iteration-statements.md | Added version note; refined iteration statement explanations |
| fixed.md | Added version note; clarified fixed statement usage |
| exception-handling-statements.md | Added version note; improved exception handling documentation |
| declarations.md | Added version note; enhanced declaration statement explanations |
| checked-and-unchecked.md | Added version note; clarified overflow-checking context |
| preprocessor-directives.md | Added version note; improved preprocessor directive documentation with one critical error |
| language-versioning.md | Added version note; updated Visual Studio compatibility reference |
| configure-language-version.md | Added version note; refined language version configuration guidance |
Contributes to #50891
Commit by commit:
Internal previews
Toggle expand/collapse
throw,try-catch,try-finally, andtry-catch-finallyfor,foreach,do, andwhileif,if-else, andswitch