document internal/controller#205
Conversation
c5a38f5 to
7344e2c
Compare
renormalize
left a comment
There was a problem hiding this comment.
Seems like many functions in operator/internal/controller/podcliqueset/ were not documented.
If this PR intends to make the doc strings exhaustive for all functions in internal/controller, then can the remaining functions be documented as well? Thanks.
|
@renormalize, thanks for catching the missing documentation. I've added more specific steps to verify there's no missing documentation into prompt. I'm now using Claude 4.5 Sonnet Thinking and this updated prompt: Improve the inline documentation for for all golang files under this directory/package. Here are the rules to follow:
Example of documentation that isn't useful and should be avoided: Systematically check every golang file under this directory is documented as per the instructions above. Check every file, here's some useful tools: List target directoriesfind -type d Check for undocumented functions in specific package (run this again after you'd made changes to verify)find -name ".go" -not -name "_test.go" How this command works:
|
df2c302 to
999a001
Compare
There was a problem hiding this comment.
Thanks for incorporating all the requested changes @gflarity!
Added 2 more comments, after which we can go ahead with the merge.
Also, thanks for updating the PR with the updated prompt used to generate the documentation!
PS: was unable to provide a suggested change in the comment since GitHub refuses to show that button to me for some reason :/
Signed-off-by: Geoff Flarity <gflarity@nvidia.com>
Co-authored-by: Saketh Kalaga <51327242+renormalize@users.noreply.github.com> Signed-off-by: Geoff Flarity <geoff.flarity@gmail.com>
Co-authored-by: Saketh Kalaga <51327242+renormalize@users.noreply.github.com> Signed-off-by: Geoff Flarity <geoff.flarity@gmail.com>
Co-authored-by: Saketh Kalaga <51327242+renormalize@users.noreply.github.com> Signed-off-by: Geoff Flarity <geoff.flarity@gmail.com>
Signed-off-by: Geoff Flarity <gflarity@nvidia.com>
Signed-off-by: Geoff Flarity <gflarity@nvidia.com>
999a001 to
2ae1d55
Compare
|
@renormalize Reverted those changes. PTAL |
renormalize
left a comment
There was a problem hiding this comment.
Everything looks good! Thanks!
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR improves to documentation for operator/internal/controller tree. See prompt below.
Special notes for your reviewer:
Documentation prompt:
Improve the inline documentation for for all golang files under this directory/package. Here are the rules to follow:
Example of documentation that isn't useful and should be avoided:
Systematically check every golang file under this directory is documented as per the instructions above.
Does this PR introduce a API change?