Updating implementation based on reviewer feedback.

pandas-dev · Feb 18, 2024 · 43d8a0e · 43d8a0e
1 parent cd4ac01
commit 43d8a0e
Showing 1 changed file with 31 additions and 31 deletions.
diff --git a/pandas/core/series.py b/pandas/core/series.py
@@ -1606,37 +1606,6 @@ def to_string(
                     f.write(result)
         return None
 
-    @doc(
-        klass=_shared_doc_kwargs["klass"],
-        storage_options=_shared_docs["storage_options"],
-        examples=dedent(
-            """Examples
-            --------
-            >>> s = pd.Series(["elk", "pig", "dog", "quetzal"], name="animal")
-            >>> print(s.to_markdown())
-            |    | animal   |
-            |---:|:---------|
-            |  0 | elk      |
-            |  1 | pig      |
-            |  2 | dog      |
-            |  3 | quetzal  |
-
-            Output markdown with a tabulate option.
-
-            >>> print(s.to_markdown(tablefmt="grid"))
-            +----+----------+
-            |    | animal   |
-            +====+==========+
-            |  0 | elk      |
-            +----+----------+
-            |  1 | pig      |
-            +----+----------+
-            |  2 | dog      |
-            +----+----------+
-            |  3 | quetzal  |
-            +----+----------+"""
-        ),
-    )
     @overload
     def to_markdown(
         self,
@@ -1673,6 +1642,37 @@ def to_markdown(
     ) -> str | None:
         ...
 
+    @doc(
+        klass=_shared_doc_kwargs["klass"],
+        storage_options=_shared_docs["storage_options"],
+        examples=dedent(
+            """Examples
+            --------
+            >>> s = pd.Series(["elk", "pig", "dog", "quetzal"], name="animal")
+            >>> print(s.to_markdown())
+            |    | animal   |
+            |---:|:---------|
+            |  0 | elk      |
+            |  1 | pig      |
+            |  2 | dog      |
+            |  3 | quetzal  |
+
+            Output markdown with a tabulate option.
+
+            >>> print(s.to_markdown(tablefmt="grid"))
+            +----+----------+
+            |    | animal   |
+            +====+==========+
+            |  0 | elk      |
+            +----+----------+
+            |  1 | pig      |
+            +----+----------+
+            |  2 | dog      |
+            +----+----------+
+            |  3 | quetzal  |
+            +----+----------+"""
+        ),
+    )
     @deprecate_nonkeyword_arguments(
         version="3.0.0", allowed_args=["self", "buf"], name="to_markdown"
     )