Skip to content

DOC: fix formatting of the validate keyword in DataFrame join docstring #54147

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 17, 2023
Merged

DOC: fix formatting of the validate keyword in DataFrame join docstring #54147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10065,11 +10065,13 @@ def join(
the order of the join key depends on the join type (how keyword).
validate : str, optional
If specified, checks if join is of specified type.

* "one_to_one" or "1:1": check if join keys are unique in both left
and right datasets.
and right datasets.
* "one_to_many" or "1:m": check if join keys are unique in left dataset.
* "many_to_one" or "m:1": check if join keys are unique in right dataset.
* "many_to_many" or "m:m": allowed, but does not result in checks.

.. versionadded:: 1.5.0

Returns
Expand Down