Skip to content

chore: improve trainer docstrings and contributing guide formatting#371

Open
VT69 wants to merge 1 commit intokubeflow:mainfrom
VT69:docs/sdk-doc-improvements
Open

chore: improve trainer docstrings and contributing guide formatting#371
VT69 wants to merge 1 commit intokubeflow:mainfrom
VT69:docs/sdk-doc-improvements

Conversation

@VT69
Copy link

@VT69 VT69 commented Mar 8, 2026

What this PR does / why we need it:

This PR improves documentation clarity and consistency in the Kubeflow Trainer SDK.

Changes include:

  • Fix docstring punctuation inconsistencies in TrainerClient.
  • Improve wording in trainer types documentation.
  • Add a blank line after the "Requirements" header in CONTRIBUTING.md for better Markdown readability.

These changes improve documentation quality and follow standard Python docstring conventions (PEP 257). No functional changes were made.

Which issue(s) this PR fixes:

N/A

Checklist:

  • Docs included if any changes are user-facing

…e readability

Signed-off-by: VT <75622110+VT69@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 8, 2026 10:42
@google-oss-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kramaranya for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@github-actions
Copy link
Contributor

github-actions bot commented Mar 8, 2026

🎉 Welcome to the Kubeflow SDK! 🎉

Thanks for opening your first PR! We're happy to have you as part of our community 🚀

Here's what happens next:

  • If you haven't already, please check out our Contributing Guide for repo-specific guidelines and the Kubeflow Contributor Guide for general community standards
  • Our team will review your PR soon! cc @kubeflow/kubeflow-sdk-team

Join the community:

Feel free to ask questions in the comments if you need any help or clarification!
Thanks again for contributing to Kubeflow! 🙏

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Improves documentation consistency and readability across the Kubeflow Trainer SDK by aligning docstrings with common conventions and cleaning up Markdown formatting.

Changes:

  • Updated/clarified docstrings in Trainer types and TrainerClient.
  • Improved wording for epochs documentation and updated external reference URL.
  • Adjusted Markdown spacing in CONTRIBUTING.md (and normalized CLAUDE.md) for better rendering.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.

File Description
kubeflow/trainer/types/types.py Updates LoRA reference URL and clarifies epochs docstring text.
kubeflow/trainer/api/trainer_client.py Docstring punctuation cleanup and minor docstring spacing change.
CONTRIBUTING.md Adds blank lines after headers and removes whitespace-only lines that can affect Markdown rendering.
CLAUDE.md Normalizes file content/formatting.

@VT69 VT69 changed the title docs(trainer): fixed docstring formatting and improved contributing guide readability docs(trainer): fix docstring formatting and improve contributing guide readability Mar 8, 2026
@VT69 VT69 changed the title docs(trainer): fix docstring formatting and improve contributing guide readability docs(trainer): fix docstring formatting Mar 8, 2026
@VT69 VT69 changed the title docs(trainer): fix docstring formatting chore: improve trainer docstrings and contributing guide formatting Mar 8, 2026
Copy link
Contributor

@astefanutti astefanutti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @VT69!

/lgtm

@astefanutti
Copy link
Contributor

/ok-to-test

@VT69
Copy link
Author

VT69 commented Mar 9, 2026

Thanks @VT69!

/lgtm

Thanks for the review! @astefanutti

@@ -1 +1 @@
AGENTS.md No newline at end of file
AGENTS.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you revert changes from this file please?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants