chore: Add missing doc strings for spark client functions#463
chore: Add missing doc strings for spark client functions#463chahatsagarmain wants to merge 1 commit into
Conversation
Signed-off-by: chahat sagar <chahatsagar2003@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Pull request overview
This PR improves the public SparkClient API documentation by expanding several method docstrings to match the repository’s Google-style docstring standards (per Issue #462).
Changes:
- Add
Returnsdocumentation forlist_sessions. - Add
Args/Returns/Raisesdocumentation forget_session,delete_session, andget_session_logs.
| """List all SparkConnect sessions. | ||
|
|
||
| Returns: | ||
| List of SparkConnectInfo objects for all sessions in the namespace. |
There was a problem hiding this comment.
list_sessions() docstring documents Returns but omits Raises, even though the backend can raise TimeoutError and RuntimeError (see RuntimeBackend.list_sessions). Add a Raises: section to keep the public API docs complete and consistent with the documented backend behavior.
| List of SparkConnectInfo objects for all sessions in the namespace. | |
| List of SparkConnectInfo objects for all sessions in the namespace. | |
| Raises: | |
| RuntimeError: If the sessions cannot be retrieved. | |
| TimeoutError: If the request to the Kubernetes API times out. |
What this PR does / why we need it:
This PR updates the
SparkClientpublic API methods (list_sessions,get_session,delete_session, andget_session_logs) to include complete Google-style docstrings.Previously, these methods were missing detailed parameter, return, and exception documentations. These changes ensure the docstrings now comprehensively detail
Args,Returns, andRaisessections, aligning with the codebase's documentation standards.Which issue(s) this PR fixes
Fixes #462
Checklist: