Skip to content

Commit fd9fd7a

Browse files
TYP: added explanation of the join methods within df.align (#53101)
* added description to join methods of alignment * Update generic.py * run ruff/black to fix type errors * Update pandas/core/generic.py Co-authored-by: Matthew Roeschke <[email protected]> * update from - to * to follow join's doc guide * Update generic.py --------- Co-authored-by: Matthew Roeschke <[email protected]>
1 parent 7304396 commit fd9fd7a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

pandas/core/generic.py

+8
Original file line numberDiff line numberDiff line change
@@ -9471,6 +9471,14 @@ def align(
94719471
----------
94729472
other : DataFrame or Series
94739473
join : {{'outer', 'inner', 'left', 'right'}}, default 'outer'
9474+
Type of alignment to be performed.
9475+
9476+
* left: use only keys from left frame, preserve key order.
9477+
* right: use only keys from right frame, preserve key order.
9478+
* outer: use union of keys from both frames, sort keys lexicographically.
9479+
* inner: use intersection of keys from both frames,
9480+
preserve the order of the left keys.
9481+
94749482
axis : allowed axis of the other object, default None
94759483
Align on index (0), columns (1), or both (None).
94769484
level : int or level name, default None

0 commit comments

Comments
 (0)