Skip to content
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

Put examples docs in remark to be visible in Visual Studio #6378

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Alirexaa
Copy link
Contributor

@Alirexaa Alirexaa commented Oct 18, 2024

Description

This pull request involves adding <remarks> tags to the XML documentation comments in multiple builder extension classes to improve clarity and consistency. The most important changes include updates to the ElasticsearchBuilderExtensions, GarnetBuilderExtensions, KeycloakResourceBuilderExtensions, MilvusBuilderExtensions, and PostgresBuilderExtensions classes.

Updates to XML Documentation Comments:

  • src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs:

    • Added <remarks> tags to provide additional context and examples for methods in the ElasticsearchBuilderExtensions class. [1] [2] [3] [4] [5] [6]
  • src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs:

    • Added <remarks> tags to provide additional context and examples for methods in the GarnetBuilderExtensions class. [1] [2] [3] [4] [5] [6] [7] [8]
  • src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs:

    • Added <remarks> tags to provide additional context and examples for methods in the KeycloakResourceBuilderExtensions class. [1] [2] [3] [4] [5]
  • src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs:

    • Added <remarks> tags to provide additional context and examples for methods in the MilvusBuilderExtensions class. [1] [2] [3] [4] [5] [6]
  • src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs:

    • Added <remarks> tags to provide additional context and examples for methods in the PostgresBuilderExtensions class. [1] [2]

Before change:

before change

after change:

after change

Fixes # (issue)

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?
    • Yes
      • Link to aspire-docs issue:
    • No
Microsoft Reviewers: Open in CodeFlow

@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Oct 18, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant