Skip to content

Conversation

daniloneto
Copy link
Contributor

Fix userstore xml doc

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Summary of the changes (Less than 80 chars)

Description

Fix userstore xml doc

Fixes #63370

@Copilot Copilot AI review requested due to automatic review settings September 19, 2025 22:07
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 inaccurate XML documentation for the TKey type parameter in multiple UserStore class definitions. The documentation incorrectly described TKey as only the primary key type for roles, when it actually represents the primary key type for both user and role entities.

  • Updated XML documentation to accurately describe the TKey parameter's purpose
  • Fixed inconsistent documentation across three UserStore class variants

@github-actions github-actions bot added the area-identity Includes: Identity and providers label Sep 19, 2025
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Sep 19, 2025
Copy link
Member

@MackinnonBuck MackinnonBuck left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution, @daniloneto!

Would you also be interested in updating UserOnlyStore.cs and UserStoreBase.cs? Those files also appear to have incorrectly copy/pasted XML docs for TKey.

@daniloneto
Copy link
Contributor Author

Thanks for the contribution, @daniloneto!

Would you also be interested in updating UserOnlyStore.cs and UserStoreBase.cs? Those files also appear to have incorrectly copy/pasted XML docs for TKey.

Thanks for pointing that out! Yes, I can update UserOnlyStore.cs and UserStoreBase.cs to fix the XML docs for TKey. I’ll include those changes in this PR

@daniloneto
Copy link
Contributor Author

Done! @MackinnonBuck

@MackinnonBuck
Copy link
Member

Great, thanks again @daniloneto!

@MackinnonBuck MackinnonBuck merged commit 02d157c into dotnet:main Sep 24, 2025
30 checks passed
@dotnet-policy-service dotnet-policy-service bot added this to the 11.0-preview1 milestone Sep 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-identity Includes: Identity and providers 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.

Misleading documentation in UserStore
2 participants