Skip to content

Fix typo in doccomment in ContainerResourceBuilderExtensions.cs #9342

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

Merged
merged 2 commits into from
May 16, 2025

Conversation

KuraiAndras
Copy link
Contributor

@KuraiAndras KuraiAndras commented May 15, 2025

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #9341

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

Other information

Although it is doc related; this part of the docs is the API docs which are generated from this source if I understand correctly.

@Copilot Copilot AI review requested due to automatic review settings May 15, 2025 21:35
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label May 15, 2025
@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label May 15, 2025
Copy link
Contributor

@Copilot 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 fixes a documentation typo by updating the generic method syntax in the API doc comments for improved clarity and correctness.

  • Corrected the usage of generic syntax from curly braces {} to angle brackets <> in doc comments.
  • Ensures generated API docs accurately reflect proper usage patterns.

@KuraiAndras KuraiAndras changed the title Fix typ in doccomment in ContainerResourceBuilderExtensions.cs Fix typo in doccomment in ContainerResourceBuilderExtensions.cs May 15, 2025
@KuraiAndras KuraiAndras requested a review from Copilot May 16, 2025 08:21
Copy link
Contributor

@Copilot 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 fixes a typo in the doc comment of ContainerResourceBuilderExtensions.cs to ensure that the sample usage of generic methods correctly utilizes HTML-encoded angle brackets.

  • Fixes generic type syntax in doc comments for clearer API documentation.

@davidfowl
Copy link
Member

Thanks!

@davidfowl davidfowl enabled auto-merge (squash) May 16, 2025 13:48
@davidfowl davidfowl merged commit 86e1f2a into dotnet:main May 16, 2025
254 checks passed
@KuraiAndras KuraiAndras deleted the fix-docs branch May 16, 2025 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates that the PR has been added by a community member needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation typo in ContainerResourceBuilderExtensions.cs
2 participants