Merged
Conversation
jabbate19
previously approved these changes
Apr 1, 2025
Collaborator
jabbate19
left a comment
jabbate19
left a comment
There was a problem hiding this comment.
Approving, but can we add documentation regarding input parameters? Isn't instantly clear that it is just a variable that exists
Collaborator
Author
|
Good call out! |
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?
/kind documentation
What this PR does / why we need it:
Right now we don't provide guidance on how to write tomes well.
This PR adds a set of best practices that have been developed from the last two years.
Which issue(s) this PR fixes:
Fixes #