Fix: KafkaServerResource documentation #13585
Conversation
…fka broker from container
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 13585Or
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 13585" |
There was a problem hiding this comment.
Pull request overview
This PR fixes a documentation error in the KafkaServerResource class by clarifying that the InternalEndpoint property should be used for container-to-Kafka broker communication, not host process communication.
Key change:
- Corrected the XML documentation comment for the
PrimaryEndpointproperty to accurately describe when to useInternalEndpoint
| /// <summary> | ||
| /// Gets the primary endpoint for the Kafka broker. This endpoint is used for host processes to Kafka broker communication. | ||
| /// To connect to the Kafka broker from a host process, use <see cref="InternalEndpoint"/>. | ||
| /// To connect to the Kafka broker from a container, use <see cref="InternalEndpoint"/>. |
There was a problem hiding this comment.
The documentation update correctly clarifies that InternalEndpoint should be used for container-to-Kafka communication. However, the InternalEndpoint property documentation at line 39-41 now has inconsistent guidance. It states "To connect to the Kafka broker from a host process, use PrimaryEndpoint" which is correct, but it should also be updated to clarify its own purpose more explicitly to match the pattern used here.
For consistency, consider updating the InternalEndpoint summary to read: "Gets the internal endpoint for the Kafka broker. This endpoint is used for container to Kafka broker communication. To connect to the Kafka broker from a host process, use ..."
This would make both endpoints' documentation follow the same pattern: stating what the current endpoint is for, then directing to the other endpoint for the alternative scenario.
There was a problem hiding this comment.
It already is like that though
Description
This pull request makes a minor documentation clarification in the
KafkaServerResourceclass. The summary comment for thePrimaryEndpointproperty is updated to clarify that theInternalEndpointis intended for container-to-Kafka broker communication, not host process communication.KafkaServerResource.cs: Updated the XML summary of thePrimaryEndpointproperty to specify thatInternalEndpointshould be used for container-to-Kafka broker communication instead of host processes.Checklist
<remarks />and<code />elements on your triple slash comments?doc-ideatemplatebreaking-changetemplatediagnostictemplate