Skip to content

Docstring for show_versions in master #33108

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

Closed
wants to merge 4 commits into from
Closed

Conversation

MarianD
Copy link
Contributor

@MarianD MarianD commented Mar 28, 2020

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

@MarianD
Copy link
Contributor Author

MarianD commented Mar 29, 2020

Connected with issue #33044 and PR #33073.

Copy link
Contributor

@jreback jreback left a comment

Choose a reason for hiding this comment

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

this needs an entry in pandas/doc/source/reference/general_functions.py maybe in the Testing section

@jreback jreback added the Docs label Mar 29, 2020
@@ -88,6 +88,20 @@ def _get_dependency_info() -> Dict[str, JSONSerializable]:


def show_versions(as_json: Union[str, bool] = False) -> None:
"""
Provides useful information, important for bug reports.
Copy link
Contributor

Choose a reason for hiding this comment

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

remove this first sentence and replace with the 2nd.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jreback, I originally had it in the form as you suggest, but the 2nd sentence is too long to be in one line, and it is not allowed to have the heading in 2 lines.

@mroeschke
Copy link
Member

As @MomIsBestFriend mentions #33073 (comment), you can just update #33073 and merge master into that branch.

Let's continue development in #33073 and address @jreback's comments there

@mroeschke mroeschke closed this Mar 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants