Clarify meaning of the group name specified in WithGroupName #59784
+4
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-issue-labeler
bot
added
the
area-networking
mikekistler
commented
Jan 9, 2025
| @@ -115,7 +115,8 @@ public static TBuilder WithName<TBuilder>(this TBuilder builder, string endpoint | |||
| /// Sets the <see cref="EndpointGroupNameAttribute"/> for all endpoints produced | |||
There was a problem hiding this comment.
This also seems confusing -- what does it mean to "set an attribute"?
Maybe this should say "Sets the IEndpointGroupNameMetadata" ? or ???
There was a problem hiding this comment.
Yeah, I think this doc comment is attempting to apply a literal description of what this method is doing. It instantiates the EndpointGroupNameAttribute class and adds it to the metadata collection.
However, that's a means to an end for the real valuable thing which is the fact that EndpointGroupNameAttribute implements the IEndpointGroupNameMetadata interface. That's what's actually relevant here so I think your recommendation of referencing the interface instead of the class is a good one.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes a small change to the description of the value passed to
WithGroupNameto explain how it is used in OpenAPI document generation. The prior text was inaccurate because there is no "GroupName" in the OpenAPI specification.