Skip to content

[SPARK-40009][PYTHON][DOCS] Add missing doc string info to DataFrame API#37441

Closed
khalidmammadov wants to merge 2 commits intoapache:masterfrom
khalidmammadov:union_doc_string
Closed

[SPARK-40009][PYTHON][DOCS] Add missing doc string info to DataFrame API#37441
khalidmammadov wants to merge 2 commits intoapache:masterfrom
khalidmammadov:union_doc_string

Conversation

@khalidmammadov
Copy link
Copy Markdown
Contributor

Adding examples and parameters description to union and unionAll

What changes were proposed in this pull request?

Documentation enhancements

Why are the changes needed?

Help user to understand functions

Does this PR introduce any user-facing change?

Yes, improves documentation

How was this patch tested?

unit test

@khalidmammadov khalidmammadov changed the title [WIP] Add doc string to DataFrame union and unionAll [SPARK-40009][PYTHON][DOCS] Add doc string to DataFrame union and unionAll Aug 8, 2022
@khalidmammadov
Copy link
Copy Markdown
Contributor Author

@HyukjinKwon @srowen please review

Copy link
Copy Markdown
Member

@srowen srowen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine; do you want to add more missing docstrings in one go?

@AmplabJenkins
Copy link
Copy Markdown

Can one of the admins verify this patch?

@HyukjinKwon
Copy link
Copy Markdown
Member

Yeah can we fix the whole file instead of one API alone?

Comment thread python/pyspark/sql/dataframe.py Outdated

Also as standard in SQL, this function resolves columns by position (not by name).

Note: This is identical to :func:`union` function
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just probably mention that it's an alias, and remove Examples section.

@HyukjinKwon
Copy link
Copy Markdown
Member

BTW thanks for working on this @khalidmammadov

@khalidmammadov
Copy link
Copy Markdown
Contributor Author

Sure, will work on whole file and revert

@khalidmammadov
Copy link
Copy Markdown
Contributor Author

@HyukjinKwon @srowen please review

@khalidmammadov khalidmammadov changed the title [SPARK-40009][PYTHON][DOCS] Add doc string to DataFrame union and unionAll [SPARK-40009][PYTHON][DOCS] Add missing doc string info to DataFrame API Aug 14, 2022
@khalidmammadov
Copy link
Copy Markdown
Contributor Author

I have also checked how they look using bundle exec jekyll serve --host 0.0.0.0

@srowen
Copy link
Copy Markdown
Member

srowen commented Aug 16, 2022

Merged to master

@srowen srowen closed this in 2511584 Aug 16, 2022
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.

4 participants