[SPARK-53970][PYTHON] Remove incorrect 'optional' tag for messageName…#54797
Closed
volcano-mite wants to merge 1 commit intoapache:masterfrom
Closed
[SPARK-53970][PYTHON] Remove incorrect 'optional' tag for messageName…#54797volcano-mite wants to merge 1 commit intoapache:masterfrom
volcano-mite wants to merge 1 commit intoapache:masterfrom
Conversation
… in protobuf functions docstring
allisonwang-db
approved these changes
Mar 17, 2026
HyukjinKwon
approved these changes
Mar 17, 2026
Member
|
Merged to master. |
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 changes were proposed in this pull request?
This PR fixes a minor documentation inconsistency in
pyspark/sql/protobuf/functions.py. It removes theoptionaltag from themessageNameparameter in the docstrings of both thefrom_protobufandto_protobuffunctions.Why are the changes needed?
As reported in SPARK-53970, the function signatures define
messageNameas a required positional argument (it has no default value). However, the docstrings incorrectly labeled it asoptional. This mismatch could mislead developers into thinking they can omit the argument, which would result in aTypeError. Updating the docstring ensures it accurately reflects the code's behavior.Does this PR introduce any user-facing change?
No. This is a documentation-only fix.
How was this patch tested?
Manual review of the docstring changes. Passed local Python linter checks (
./dev/lint-python) to ensure no style regressions.Was this patch authored or co-authored using generative AI tooling?
No.