-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
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
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1765a1c
DOC: Added docstring for show_versions()
MarianD 96ba47f
DOC: Updating docstring for show_versions()
MarianD 32c00b9
DOC: Fixed docstring for show_versions()
MarianD 1c07c53
DOC: Fixed superfluous whitespaces in docstring
MarianD 1cae13a
DOC: Added show_versions() to API docs
MarianD dc7d187
DOC: show_versions() fix in docstring / API docs
MarianD File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -88,6 +88,22 @@ def _get_dependency_info() -> Dict[str, JSONSerializable]: | |
|
||
|
||
def show_versions(as_json: Union[str, bool] = False) -> None: | ||
""" | ||
Provides information 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. | ||
|
||
Returns | ||
------- | ||
None | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this section can be omitted when there's no return value. |
||
""" | ||
sys_info = _get_sys_info() | ||
deps = _get_dependency_info() | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Needs to be a single line.