Skip to content

Fix documentation comment code tags#9572

Merged
glen-84 merged 2 commits intomainfrom
gai/fix-code-tags
Apr 17, 2026
Merged

Fix documentation comment code tags#9572
glen-84 merged 2 commits intomainfrom
gai/fix-code-tags

Conversation

@glen-84
Copy link
Copy Markdown
Member

@glen-84 glen-84 commented Apr 17, 2026

Summary of the changes (Less than 80 chars)

  • Fix documentation comment code tags.

Copilot AI review requested due to automatic review settings April 17, 2026 10:41
Copy link
Copy Markdown
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

Updates XML documentation to use the correct inline code tag and enables an analyzer rule to keep this consistent across the codebase.

Changes:

  • Replaced inline <code>...</code> usages with <c>...</c> in XML documentation comments.
  • Enabled Roslynator analyzer RCS1247 (“Fix documentation comment tag”) as a warning.

Reviewed changes

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

File Description
src/HotChocolate/Core/src/Types.Mutations/MutationConventionOptions.cs Switches inline code examples in mutation convention docs to <c> for correct XML doc formatting.
src/HotChocolate/Core/src/Subscriptions.Nats/DependencyInjection/NatsPubSubExtensions.cs Updates inline method reference to <c> in the public API documentation.
.editorconfig Enables dotnet_diagnostic.RCS1247 to enforce correct documentation tag usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants