Skip to content

Conversation

@khalidmammadov
Copy link
Contributor

What changes were proposed in this pull request?

It's part of the Pyspark docstrings improvement series (#37592, #37662, #37686, #37786, #37797, #37850)

In this PR I mainly covered missing parts in the docstrings adding some more examples where it needed.

I have also made all examples self explanatory by providing DataFrame creation command where it was missing for clarity to a user.

This should complete "my take" on functions.py docstrings & example improvements.

Why are the changes needed?

To improve PySpark documentation

Does this PR introduce any user-facing change?

Yes, documentation

How was this patch tested?

PYTHON_EXECUTABLE=python3.9 ./dev/lint-python
./python/run-tests --testnames pyspark.sql.functions
bundle exec jekyll build

@AmplabJenkins
Copy link

Can one of the admins verify this patch?

@khalidmammadov
Copy link
Contributor Author

@srowen @itholic @HyukjinKwon Please review

@HyukjinKwon
Copy link
Member

Thanks for finishing this work, @khalidmammadov.

@khalidmammadov
Copy link
Contributor Author

Thanks for finishing this work, @khalidmammadov.

Happy to help

@srowen
Copy link
Member

srowen commented Sep 25, 2022

Merged to master

@srowen srowen closed this in 57e6cf0 Sep 25, 2022
@itholic
Copy link
Contributor

itholic commented Sep 25, 2022

Thanks for your efforts to finish this work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants