Skip to content

Commit 24857a2

Browse files
authored
Improve document for **kwargs argument of pandas.Series.to_markdown (#34616)
1 parent 79fb1dd commit 24857a2

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

pandas/core/series.py

+15
Original file line numberDiff line numberDiff line change
@@ -1422,6 +1422,21 @@ def to_string(
14221422
| 1 | pig |
14231423
| 2 | dog |
14241424
| 3 | quetzal |
1425+
1426+
Output markdown with a tabulate option.
1427+
1428+
>>> print(s.to_markdown(tablefmt="grid"))
1429+
+----+----------+
1430+
| | animal |
1431+
+====+==========+
1432+
| 0 | elk |
1433+
+----+----------+
1434+
| 1 | pig |
1435+
+----+----------+
1436+
| 2 | dog |
1437+
+----+----------+
1438+
| 3 | quetzal |
1439+
+----+----------+
14251440
"""
14261441
)
14271442
@Substitution(klass="Series")

0 commit comments

Comments
 (0)