-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Update dependency for to_markdown documentation #36938
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Adding to the documentation that tabulate is required for to_markdown to be executed
Thanks @eyaltrabelsi , but we already raise an import error if
, does this need to be added to the docstring? |
@MarcoGorelli In my opinion it should be part of the documentation as well, but if you think its unneeded we can close this PR :) |
pandas/core/series.py
Outdated
@@ -1471,6 +1471,10 @@ def to_markdown( | |||
str | |||
{klass} in Markdown-friendly format. | |||
|
|||
Notes | |||
----- | |||
This method requires the tabulate package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps link to it as well, while we're here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MarcoGorelli thanks for feedback, I have added the link
Co-authored-by: Marco Gorelli <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @eyaltrabelsi !
* Update to_markdown documentation Adding to the documentation that tabulate is required for to_markdown to be executed * Move the optional dependency to a note * Update series.py * Update series.py * Update pandas/core/series.py Co-authored-by: Marco Gorelli <[email protected]> Co-authored-by: Marco Gorelli <[email protected]>
* Update to_markdown documentation Adding to the documentation that tabulate is required for to_markdown to be executed * Move the optional dependency to a note * Update series.py * Update series.py * Update pandas/core/series.py Co-authored-by: Marco Gorelli <[email protected]> Co-authored-by: Marco Gorelli <[email protected]>
Adding to the documentation that tabulate is required for to_markdown to be executed
black pandas
git diff upstream/master -u -- "*.py" | flake8 --diff