Skip to content

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

Merged
danmoseley merged 6 commits intomicrosoft:mainfrom
Alirexaa:fix-xml-docs
Feb 3, 2025
Merged

Put examples docs in remark to be visible in Visual Studio#6378
danmoseley merged 6 commits intomicrosoft:mainfrom
Alirexaa:fix-xml-docs

Conversation

@Alirexaa
Copy link
Copy Markdown
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
Comment thread src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs Outdated
@danmoseley
Copy link
Copy Markdown
Member

thanks @Alirexaa just one comment.

@danmoseley danmoseley closed this Feb 2, 2025
@danmoseley danmoseley reopened this Feb 2, 2025
@danmoseley danmoseley self-assigned this Feb 2, 2025
@danmoseley danmoseley added the needs-author-action An issue or pull request that requires more info or actions from the author. label Feb 2, 2025
Comment thread src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs Outdated
Comment thread src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs Outdated
Comment thread src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs Outdated
@dotnet-policy-service dotnet-policy-service Bot removed the needs-author-action An issue or pull request that requires more info or actions from the author. label Feb 3, 2025
@Alirexaa
Copy link
Copy Markdown
Contributor Author

Alirexaa commented Feb 3, 2025

@danmoseley thanks for your attention. I merged the branch with the latest changes and fixed dups.

Copy link
Copy Markdown
Member

@danmoseley danmoseley left a comment

Choose a reason for hiding this comment

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

thanks again for patience.

@danmoseley danmoseley merged commit 5e7611b into microsoft:main Feb 3, 2025
@Alirexaa Alirexaa deleted the fix-xml-docs branch February 3, 2025 19:32
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 6, 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 Mar 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

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.

2 participants