Skip to content

Commit 563c55d

Browse files
committed
ENH/DOC: Cleanup docstrings on NDFrame
1 parent 5168a57 commit 563c55d

File tree

4 files changed

+151
-63
lines changed

4 files changed

+151
-63
lines changed

pandas/core/frame.py

+23-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
_default_index, _maybe_upcast, _is_sequence,
2727
_infer_dtype_from_scalar, _values_from_object,
2828
_coerce_to_dtypes, _DATELIKE_DTYPES, is_list_like)
29-
from pandas.core.generic import NDFrame
29+
from pandas.core.generic import NDFrame, _shared_docs
3030
from pandas.core.index import Index, MultiIndex, _ensure_index
3131
from pandas.core.indexing import (_maybe_droplevels,
3232
_convert_to_index_sliceable,
@@ -62,6 +62,9 @@
6262
#----------------------------------------------------------------------
6363
# Docstring templates
6464

65+
_shared_doc_kwargs = dict(axes='index, columns',
66+
klass='DataFrame',
67+
axes_single_arg="{0,1,'index','columns'}")
6568

6669
_numeric_only_doc = """numeric_only : boolean, default None
6770
Include only float, int, boolean data. If None, will attempt to use
@@ -1380,6 +1383,7 @@ def ftypes(self):
13801383
return self.apply(lambda x: x.ftype, reduce=False)
13811384

13821385
def transpose(self):
1386+
"""Transpose index and columns"""
13831387
return super(DataFrame, self).transpose(1, 0)
13841388

13851389
T = property(transpose)
@@ -2157,6 +2161,24 @@ def _reindex_multi(self, axes, copy, fill_value):
21572161
return self._reindex_with_indexers({0: [new_index, row_indexer],
21582162
1: [new_columns, col_indexer]}, copy=copy, fill_value=fill_value)
21592163

2164+
@Appender(_shared_docs['reindex'] % _shared_doc_kwargs)
2165+
def reindex(self, index=None, columns=None, **kwargs):
2166+
return super(DataFrame, self).reindex(index=index, columns=columns,
2167+
**kwargs)
2168+
2169+
@Appender(_shared_docs['reindex_axis'] % _shared_doc_kwargs)
2170+
def reindex_axis(self, labels, axis=0, method=None, level=None, copy=True,
2171+
limit=None, fill_value=np.nan):
2172+
return super(DataFrame, self).reindex_axis(labels=labels, axis=axis,
2173+
method=method, level=level,
2174+
copy=copy, limit=limit,
2175+
fill_value=fill_value)
2176+
2177+
@Appender(_shared_docs['rename'] % _shared_doc_kwargs)
2178+
def rename(self, index=None, columns=None, **kwargs):
2179+
return super(DataFrame, self).rename(index=index, columns=columns,
2180+
**kwargs)
2181+
21602182
def reindex_like(self, other, method=None, copy=True, limit=None,
21612183
fill_value=NA):
21622184
"""

0 commit comments

Comments
 (0)