Skip to content

Commit

Permalink
[SPARK-50352][PYTHON][DOCS] Refine docstrings for window/aggregation …
Browse files Browse the repository at this point in the history
…functions - part 3

### What changes were proposed in this pull request?
Refine docstrings for window/aggregation functions:

1, make examples copy-pasteable;
2, specify the meaning of str input: either column name or literal string;
3, show both input and output columns;
4, add see also section for related functions;

### Why are the changes needed?
1, improve the documentation;
2, improve the doctest coverage;

### Does this PR introduce _any_ user-facing change?
doc changes

### How was this patch tested?
updated doctests

### Was this patch authored or co-authored using generative AI tooling?
no

Closes #48891 from zhengruifeng/py_doc_5.

Authored-by: Ruifeng Zheng <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
  • Loading branch information
zhengruifeng authored and HyukjinKwon committed Nov 20, 2024
1 parent 37497e6 commit c149dcb
Showing 1 changed file with 300 additions and 161 deletions.
Loading

0 comments on commit c149dcb

Please sign in to comment.