From bb49cd808fdb014836ba6c5a5fa9b03cb1831b0d Mon Sep 17 00:00:00 2001 From: Kevin Sheppard Date: Fri, 7 Oct 2022 10:25:41 +0100 Subject: [PATCH] DOC: Improve documented types for merge Correct list of supported types in docs Remove block creating incorrect docs in merge --- pandas/core/reshape/merge.py | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/pandas/core/reshape/merge.py b/pandas/core/reshape/merge.py index b05340fcb96a5..163241a516bee 100644 --- a/pandas/core/reshape/merge.py +++ b/pandas/core/reshape/merge.py @@ -127,10 +127,6 @@ def merge( return op.get_result(copy=copy) -if __debug__: - merge.__doc__ = _merge_doc % "\nleft : DataFrame" - - def _groupby_and_merge(by, left: DataFrame, right: DataFrame, merge_pieces): """ groupby & merge; we are always performing a left-by type operation @@ -207,8 +203,8 @@ def merge_ordered( Parameters ---------- - left : DataFrame - right : DataFrame + left : DataFrame or named Series + right : DataFrame or named Series on : label or list Field names to join on. Must be found in both DataFrames. left_on : label or list, or array-like @@ -220,10 +216,10 @@ def merge_ordered( left_on docs. left_by : column name or list of column names Group left DataFrame by group columns and merge piece by piece with - right DataFrame. + right DataFrame. Must be None if either left or right are a Series. right_by : column name or list of column names Group right DataFrame by group columns and merge piece by piece with - left DataFrame. + left DataFrame. Must be None if either left or right are a Series. fill_method : {'ffill', None}, default None Interpolation method for data. suffixes : list-like, default is ("_x", "_y")