Skip to content

Commit c9e2976

Browse files
improve docstring
1 parent 8904332 commit c9e2976

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

pandas/core/reshape/merge.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,13 @@ def merge_ordered(left, right, on=None,
159159
left DataFrame
160160
fill_method : {'ffill', None}, default None
161161
Interpolation method for data
162-
suffixes : 2-length sequence (tuple, list, ...)
163-
Suffix to apply to overlapping column names in the left and right
164-
side, respectively. And each element should be either a str or None,
165-
and at least one of elements must not be str. Valid inputs are like:
166-
(str, str), [str, str], (None, str), [str, None], [None, str] etc
162+
suffixes : Sequence
163+
A length-2 sequence where each element is optionally a string
164+
indicating the suffix to add to overlapping column names in
165+
`left` and `right` respectively. Pass a value of `None` instead
166+
of a string to indicate that the column name from `left` or
167+
`right` should be left as-is, with no suffix. At least one of the
168+
values must not be None.
167169
how : {'left', 'right', 'outer', 'inner'}, default 'outer'
168170
* left: use only keys from left frame (SQL: left outer join)
169171
* right: use only keys from right frame (SQL: right outer join)

0 commit comments

Comments
 (0)