Skip to content

Commit 04a772b

Browse files
smartvinnetouwesbarnett
authored andcommitted
CLN: Using doc decorator instead of Appender/Substitution in several Series/DataFrame methods (pandas-dev#33277)
1 parent 3dd9653 commit 04a772b

File tree

9 files changed

+360
-372
lines changed

9 files changed

+360
-372
lines changed

pandas/core/frame.py

+18-14
Original file line numberDiff line numberDiff line change
@@ -2183,9 +2183,10 @@ def to_feather(self, path, **kwargs) -> None:
21832183

21842184
to_feather(self, path, **kwargs)
21852185

2186-
@Appender(
2187-
"""
2188-
Examples
2186+
@doc(
2187+
Series.to_markdown,
2188+
klass=_shared_doc_kwargs["klass"],
2189+
examples="""Examples
21892190
--------
21902191
>>> df = pd.DataFrame(
21912192
... data={"animal_1": ["elk", "pig"], "animal_2": ["dog", "quetzal"]}
@@ -2206,10 +2207,8 @@ def to_feather(self, path, **kwargs) -> None:
22062207
+----+------------+------------+
22072208
| 1 | pig | quetzal |
22082209
+----+------------+------------+
2209-
"""
2210+
""",
22102211
)
2211-
@Substitution(klass="DataFrame")
2212-
@Appender(_shared_docs["to_markdown"])
22132212
def to_markdown(
22142213
self, buf: Optional[IO[str]] = None, mode: Optional[str] = None, **kwargs
22152214
) -> Optional[str]:
@@ -4758,20 +4757,20 @@ def _maybe_casted_values(index, labels=None):
47584757
# ----------------------------------------------------------------------
47594758
# Reindex-based selection methods
47604759

4761-
@Appender(_shared_docs["isna"] % _shared_doc_kwargs)
4760+
@doc(NDFrame.isna, klass=_shared_doc_kwargs["klass"])
47624761
def isna(self) -> "DataFrame":
47634762
result = self._constructor(self._data.isna(func=isna))
47644763
return result.__finalize__(self, method="isna")
47654764

4766-
@Appender(_shared_docs["isna"] % _shared_doc_kwargs)
4765+
@doc(NDFrame.isna, klass=_shared_doc_kwargs["klass"])
47674766
def isnull(self) -> "DataFrame":
47684767
return self.isna()
47694768

4770-
@Appender(_shared_docs["notna"] % _shared_doc_kwargs)
4769+
@doc(NDFrame.notna, klass=_shared_doc_kwargs["klass"])
47714770
def notna(self) -> "DataFrame":
47724771
return ~self.isna()
47734772

4774-
@Appender(_shared_docs["notna"] % _shared_doc_kwargs)
4773+
@doc(NDFrame.notna, klass=_shared_doc_kwargs["klass"])
47754774
def notnull(self) -> "DataFrame":
47764775
return ~self.isna()
47774776

@@ -7330,13 +7329,14 @@ def _gotitem(
73307329
"""
73317330
)
73327331

7333-
@Substitution(
7332+
@doc(
7333+
_shared_docs["aggregate"],
7334+
klass=_shared_doc_kwargs["klass"],
7335+
axis=_shared_doc_kwargs["axis"],
73347336
see_also=_agg_summary_and_see_also_doc,
73357337
examples=_agg_examples_doc,
73367338
versionadded="\n.. versionadded:: 0.20.0\n",
7337-
**_shared_doc_kwargs,
73387339
)
7339-
@Appender(_shared_docs["aggregate"])
73407340
def aggregate(self, func, axis=0, *args, **kwargs):
73417341
axis = self._get_axis_number(axis)
73427342

@@ -7364,7 +7364,11 @@ def _aggregate(self, arg, axis=0, *args, **kwargs):
73647364

73657365
agg = aggregate
73667366

7367-
@Appender(_shared_docs["transform"] % _shared_doc_kwargs)
7367+
@doc(
7368+
NDFrame.transform,
7369+
klass=_shared_doc_kwargs["klass"],
7370+
axis=_shared_doc_kwargs["axis"],
7371+
)
73687372
def transform(self, func, axis=0, *args, **kwargs) -> "DataFrame":
73697373
axis = self._get_axis_number(axis)
73707374
if axis == 1:

0 commit comments

Comments
 (0)