Skip to content

Improve snippets in XML documentation comments example page #45070

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

Conversation

Rageking8
Copy link
Contributor

Summary

Move ClassExample snippet closing tag inside of the namespace, to prevent an extra level of indentation and a stray closing brace in the rendered output. This PR also includes a slight formatting fix in tagged-library.cs.

@Rageking8 Rageking8 requested review from BillWagner and a team as code owners February 28, 2025 08:06
@dotnetrepoman dotnetrepoman bot added this to the February 2025 milestone Feb 28, 2025
@dotnet-policy-service dotnet-policy-service bot added dotnet-csharp/svc lang-reference/subsvc community-contribution Indicates PR is created by someone from the .NET community. labels Feb 28, 2025
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

Thanks @Rageking8

This LGTM, and I'll :shipit: now.

In future PRs, we've been converting to file-scoped namespaces where there is one namespace in the file. If you make that change in a single commit, we can still review other changes using the commit view on the PR, so it's not a big cost to reviewers.

Thanks again for all the contributions.

@BillWagner BillWagner enabled auto-merge (squash) February 28, 2025 13:50
@BillWagner BillWagner merged commit 51715fc into dotnet:main Feb 28, 2025
12 checks passed
@Rageking8 Rageking8 deleted the improve-snippets-in-xml-documentation-comments-example-page branch March 27, 2025 08:21
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-csharp/svc lang-reference/subsvc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants