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.

Sign up for GitHub

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

Docstring for show_versions in master #33108

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1765a1c
DOC: Added docstring for show_versions()
MarianD Mar 27, 2020
96ba47f
DOC: Updating docstring for show_versions()
MarianD Mar 27, 2020
32c00b9
DOC: Fixed docstring for show_versions()
MarianD Mar 27, 2020
1c07c53
DOC: Fixed superfluous whitespaces in docstring
MarianD Mar 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions pandas/util/_print_versions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


It comprises info about hosting operation system, pandas version,
and versions of other installed relative packages.

Parameters
----------
as_json : str or bool, default False
* If False, outputs info in a human readable form to the console.
* If str, it will be considered as a path to a file.
Info will be written to that file in JSON format.
* If True, outputs info in JSON format to the console.
"""
sys_info = _get_sys_info()
deps = _get_dependency_info()

Expand Down