Skip to content

DOC: Added docstring for show_versions() #33073

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 6 commits into from
Mar 31, 2020
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
7 changes: 7 additions & 0 deletions doc/source/reference/general_utility_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ Testing functions
testing.assert_index_equal
testing.assert_extension_array_equal

Bug report function
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd put this at the bottom of this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@TomAugspurger, I did it.

-------------------
.. autosummary::
:toctree: api/

show_versions

Exceptions and warnings
-----------------------
.. autosummary::
Expand Down
14 changes: 14 additions & 0 deletions pandas/util/_print_versions.py
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.

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