DOC: The argument of pandas.DataFrame.to_markdown is unfriendly
See original GitHub issueLocation of the documentation
https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.to_markdown.html
Documentation problem
The document of pandas.DataFrame.to_markdown
is unfriendly because many options are shown as **kwargs
.
I think these arguments should be documented explicitly like a to_csv
.
https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.to_csv.html
Suggested fix for documentation
All arguments supported by to_markdown
should be shown at document.
If don’t mind, I would like to tackle this improvement.
Issue Analytics
- State:
- Created 3 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
pandas.DataFrame.to_markdown
Print DataFrame in Markdown-friendly format. New in version 1.0.0. Parameters. bufstr, Path or StringIO-like, optional, ...
Read more >pandas.DataFrame.to_markdown
An error will be raised if providing this argument with a non-fsspec URL. See the fsspec and backend storage implementation docs for the...
Read more >pandas.DataFrame — pandas 1.5.2 documentation
Arithmetic operations align on both row and column labels. Can be thought of as a dict-like container for Series objects. The primary pandas...
Read more >pandas.DataFrame.mean — pandas 1.5.2 documentation
Return the mean of the values over the requested axis. Parameters. axis{index (0), columns (1)} ... For Series this parameter is unused and...
Read more >pandas.DataFrame.info — pandas 1.5.2 documentation
This method prints information about a DataFrame including the index dtype and columns, non-null values and memory usage. Parameters. verbosebool, optional.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I’d caution against adding too many keyword arguments. The function could be expanded in the future to accept an
engine
function to determine which package we use to format things.So we should only add explicit keywords for names that are standard across the rest of pandas IO methods.
I noticed
pandas.Series.to_markdown
has same argument.So, I also created PR for it (#34616 ).