[MINOR][PYTHON] Add missing docstrings to add_path and read_command functions #53862
+34
−0
Conversation
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
Add comprehensive docstrings to add_path and read_command functions in pyspark/worker_util.py to improve code documentation and maintainability. The docstrings follow the NumPy style used throughout the PySpark codebase.
|
HyukjinKwon
changed the title
Member
| serializer : FramedSerializer | ||
| The serializer to use for reading the command. | ||
| file : IO | ||
| The input file to read from. |
Contributor
There was a problem hiding this comment.
Technically it's not a file. I know it's named a file, but it's more like a stream.
Contributor
|
I don't know the repo's policy about such changes. The docs itself is okay. These two methods are pretty self-explained though. |
Contributor
allisonwang-db
left a comment
allisonwang-db
left a comment
There was a problem hiding this comment.
Please create a JIRA ticket with type DOC and add it in the PR title.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Add comprehensive docstrings to add_path and read_command functions in pyspark/worker_util.py to improve code documentation and maintainability. The docstrings follow the NumPy style used throughout the PySpark codebase.
What changes were proposed in this pull request?
Why are the changes needed?
Does this PR introduce any user-facing change?
How was this patch tested?
Was this patch authored or co-authored using generative AI tooling?