[SPARK-46023][PYTHON][DOCS] Annotate parameters at docstrings in pyspark.sql module#43925
Closed
HyukjinKwon wants to merge 2 commits into
Closed
[SPARK-46023][PYTHON][DOCS] Annotate parameters at docstrings in pyspark.sql module#43925HyukjinKwon wants to merge 2 commits into
HyukjinKwon wants to merge 2 commits into
Conversation
HyukjinKwon
commented
Nov 21, 2023
| Parameters | ||
| ---------- | ||
| pattern : str | ||
| pattern : str, optional |
Member
Author
There was a problem hiding this comment.
This complies https://numpydoc.readthedocs.io/en/latest/format.html
itholic
approved these changes
Nov 21, 2023
zhengruifeng
approved these changes
Nov 21, 2023
Member
Author
|
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 proposes to annotate parameters at docstrings in
pyspark.sqlmodule, especially aboutOptional[...].Why are the changes needed?
For correct documentation to the end users.
Does this PR introduce any user-facing change?
Yes it fixes the user-facing documentation.
How was this patch tested?
Existing linter checks should be sufficient.
Was this patch authored or co-authored using generative AI tooling?
No.