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.

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

Jump to bottom
Merged
merged 6 commits into from
Mar 31, 2020
Merged

DOC: Added docstring for show_versions() #33073

merged 6 commits into from
Mar 31, 2020

Conversation

MarianD
Copy link
Contributor

@MarianD MarianD commented Mar 27, 2020 •
edited by mroeschke
Loading

@MarianD MarianD mentioned this pull request Mar 27, 2020
Closed
@MarianD
Copy link
Contributor Author

MarianD commented Mar 27, 2020

@TomAugspurger, connected with issue #33044

TomAugspurger
TomAugspurger reviewed Mar 27, 2020
View reviewed changes
Copy link
Contributor

@TomAugspurger TomAugspurger left a comment

Choose a reason for hiding this comment

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

Thanks! Can you run scripts/validate_docstrings.py on this? I don't think we need any of the other sections, just the Parameters.

You can also add it to the API docs. Probably in doc/source/reference/general_utility_functions.rst.

pandas/util/_print_versions.py Outdated
Comment on lines 103 to 105
Returns
-------
None
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

pandas/util/_print_versions.py Outdated
@@ -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,
Copy link
Contributor

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.

@TomAugspurger TomAugspurger added this to the 1.1 milestone Mar 27, 2020
@TomAugspurger
Copy link
Contributor

You can ignore the CI failure.

@pep8speaks
Copy link

pep8speaks commented Mar 27, 2020 •
edited
Loading

Hello @MarianD! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-03-30 14:23:01 UTC

@ShaharNaveh
Copy link
Member

@MarianD Can you please merge master?

@MarianD
Copy link
Contributor Author

MarianD commented Mar 28, 2020

@MomIsBestFriend

@MarianD Can you please merge master?

I merged my “docstring” branch into “master” in my fork and created pull request for that branch (master) — is it what you expected?

@MarianD MarianD mentioned this pull request Mar 29, 2020
Closed
5 tasks
@ShaharNaveh
Copy link
Member

@MomIsBestFriend

@MarianD Can you please merge master?

I merged my “docstring” branch into “master” in my fork and created pull request for that branch (master) — is it what you expected?

@MarianD sorry this is not what I expected, but it's perfectly fine.

I should have been more specific, what I meant was "please update your pull request"

https://dev.pandas.io/docs/development/contributing.html#updating-your-pull-request

This is necessary due to a failure we had in our CI (continues interrogation), and updating your PR (pull request) would solve this.

TomAugspurger
TomAugspurger reviewed Mar 30, 2020
View reviewed changes
Copy link
Contributor

@TomAugspurger TomAugspurger left a comment

Choose a reason for hiding this comment

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

Looks like there's a linting issue: https://github.com/pandas-dev/pandas/pull/33073/checks?check_run_id=543334674#step:10:9

doc/source/reference/general_utility_functions.rst Outdated
@@ -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.

@MarianD MarianD requested a review from TomAugspurger March 30, 2020 17:34
datapythonista
datapythonista approved these changes Mar 31, 2020
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

lgtm, thanks @MarianD

ping @TomAugspurger

@TomAugspurger
Copy link
Contributor

TomAugspurger commented Mar 31, 2020 •
edited
Loading

Thanks!

@TomAugspurger TomAugspurger merged commit f148cb7 into pandas-dev:master Mar 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAugspurger TomAugspurger TomAugspurger approved these changes

@datapythonista datapythonista datapythonista approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
1.1
Development

Successfully merging this pull request may close these issues.

Missing show_versions() in documentation
5 participants
@MarianD @TomAugspurger @pep8speaks @ShaharNaveh @datapythonista