Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] cudf.DataFrame.merge how options incomplete #9460

Closed
ncclementi opened this issue Oct 18, 2021 · 0 comments · Fixed by #9572
Closed

[DOC] cudf.DataFrame.merge how options incomplete #9460

ncclementi opened this issue Oct 18, 2021 · 0 comments · Fixed by #9572
Assignees
Labels
doc Documentation Python Affects Python cuDF API.

Comments

@ncclementi
Copy link

Report needed documentation and Describe the problems or issues found in the documentation

The documentation on cudf.DataFrame.merge more specifically the how part is incomplete. Docstrings are here

how : {‘left’, ‘outer’, ‘inner’}, default ‘inner’
Type of merge to be performed.
- left : use only keys from left frame, similar to a SQL left
outer join.
- right : not supported.
- outer : use union of keys from both frames, similar to a SQL
full outer join.
- inner: use intersection of keys from both frames, similar to
a SQL inner join.

and for what I read in the Merge class here

how : string
The type of join. Possible values are
'inner', 'outer', 'left', 'leftsemi' and 'leftanti'

we are missing leftsemi and leftanti on the merge documentation that will display in https://docs.rapids.ai/api/cudf/stable/api_docs/api/cudf.DataFrame.merge.html

Steps taken to verify documentation is incorrect
See dask/dask#8138 (review)

Suggested fix for documentation
"leftanti" and ""leftsemi should be added here:

how : {‘left’, ‘outer’, ‘inner’}, default ‘inner’
Type of merge to be performed.
- left : use only keys from left frame, similar to a SQL left
outer join.
- right : not supported.
- outer : use union of keys from both frames, similar to a SQL
full outer join.
- inner: use intersection of keys from both frames, similar to
a SQL inner join.

@ncclementi ncclementi added Needs Triage Need team to review and classify doc Documentation labels Oct 18, 2021
@shwina shwina added Python Affects Python cuDF API. and removed Needs Triage Need team to review and classify labels Oct 18, 2021
@galipremsagar galipremsagar self-assigned this Nov 1, 2021
@rapids-bot rapids-bot bot closed this as completed in #9572 Nov 1, 2021
rapids-bot bot pushed a commit that referenced this issue Nov 1, 2021
Resolves: #9460 

This PR adds descriptions for already supported merge options.

Authors:
  - GALI PREM SAGAR (https://github.com/galipremsagar)

Approvers:
  - H. Thomson Comer (https://github.com/thomcom)
  - Vyas Ramasubramani (https://github.com/vyasr)

URL: #9572
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation Python Affects Python cuDF API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants