Correct API documentation in PodCliqueSet#432
Merged
Conversation
Signed-off-by: Saketh Kalaga <saketh.kalaga@sap.com>
shayasoolin
approved these changes
Feb 11, 2026
sanjaychatterjee
approved these changes
Feb 12, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What type of PR is this?
What this PR does / why we need it:
/kind documentation
Related to #431.
PodCliqueSetSpec.Replicasis the number of replicas of thePodCliqueSet, not the number ofPodGangs.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
This PR is obviously not exhaustive. I spotted this error in the top level of the API, and therefore I raised this PR. Comprehensive rework of the API documentation will happen at some point in the future, but it is not ideal to leave an error in the API documentation until then.
Does this PR introduce a API change?
Additional documentation e.g., enhancement proposals, usage docs, etc.: