Skip to content

Commit 1fd894d

Browse files
bashtagephofl
andauthored
DOC: Improve documented types for merge (#48985)
Correct list of supported types in docs Remove block creating incorrect docs in merge Co-authored-by: Patrick Hoefler <[email protected]>
1 parent c7b502b commit 1fd894d

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

pandas/core/reshape/merge.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -152,10 +152,6 @@ def merge(
152152
return op.get_result(copy=copy)
153153

154154

155-
if __debug__:
156-
merge.__doc__ = _merge_doc % "\nleft : DataFrame"
157-
158-
159155
def _groupby_and_merge(by, left: DataFrame, right: DataFrame, merge_pieces):
160156
"""
161157
groupby & merge; we are always performing a left-by type operation
@@ -232,8 +228,8 @@ def merge_ordered(
232228
233229
Parameters
234230
----------
235-
left : DataFrame
236-
right : DataFrame
231+
left : DataFrame or named Series
232+
right : DataFrame or named Series
237233
on : label or list
238234
Field names to join on. Must be found in both DataFrames.
239235
left_on : label or list, or array-like
@@ -245,10 +241,10 @@ def merge_ordered(
245241
left_on docs.
246242
left_by : column name or list of column names
247243
Group left DataFrame by group columns and merge piece by piece with
248-
right DataFrame.
244+
right DataFrame. Must be None if either left or right are a Series.
249245
right_by : column name or list of column names
250246
Group right DataFrame by group columns and merge piece by piece with
251-
left DataFrame.
247+
left DataFrame. Must be None if either left or right are a Series.
252248
fill_method : {'ffill', None}, default None
253249
Interpolation method for data.
254250
suffixes : list-like, default is ("_x", "_y")

0 commit comments

Comments
 (0)