Skip to content

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

Merged
merged 5 commits into from
Oct 17, 2020

Conversation

eyaltrabelsi
Copy link

Adding to the documentation that tabulate is required for to_markdown to be executed

  • closes #xxxx
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

Adding to the documentation that tabulate is required for to_markdown to be executed
@MarcoGorelli
Copy link
Member

Thanks @eyaltrabelsi , but we already raise an import error if tabulate isn't installed

ImportError: Missing optional dependency 'tabulate'.  Use pip or conda to install tabulate.

, does this need to be added to the docstring?

@eyaltrabelsi
Copy link
Author

@MarcoGorelli In my opinion it should be part of the documentation as well, but if you think its unneeded we can close this PR :)

@jreback jreback added Dependencies Required and optional dependencies Docs Output-Formatting __repr__ of pandas objects, to_string labels Oct 10, 2020
@jreback jreback added this to the 1.2 milestone Oct 10, 2020
@@ -1471,6 +1471,10 @@ def to_markdown(
str
{klass} in Markdown-friendly format.

Notes
-----
This method requires the tabulate package.
Copy link
Member

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?

Copy link
Author

@eyaltrabelsi eyaltrabelsi Oct 17, 2020

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]>
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @eyaltrabelsi !

@eyaltrabelsi eyaltrabelsi requested a review from jreback October 17, 2020 08:56
@MarcoGorelli MarcoGorelli merged commit 40b65da into pandas-dev:master Oct 17, 2020
JulianWgs pushed a commit to JulianWgs/pandas that referenced this pull request Oct 26, 2020
* 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]>
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependencies Required and optional dependencies Docs Output-Formatting __repr__ of pandas objects, to_string
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants