Skip to content

DOC: Fix EX02 in pandas.Index.get_loc #32429

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 1 commit into from
Mar 4, 2020

Conversation

farhanreynaldo
Copy link
Contributor

@farhanreynaldo farhanreynaldo commented Mar 4, 2020

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

Related to #27977.

################################################################################
################################## Validation ##################################
################################################################################

5 Errors found:
        No extended summary found
        Parameter "key" has no description
        The first line of the Returns section should contain only the type, unless multiple values are being returned
        Return value has no description
        See Also section not found

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Thanks @farhanreynaldo

In the future I think it would help to also post the output of

python scripts/validate_docstrings.py pandas.Index.get_loc

which here is

################################################################################
################################## Validation ##################################
################################################################################

5 Errors found:
        No extended summary found
        Parameter "key" has no description
        The first line of the Returns section should contain only the type, unless multiple values are being returned
        Return value has no description
        See Also section not found

to show that the doctests now pass

@MarcoGorelli
Copy link
Member

Also, adding

xref #27977

to the pull request description would be good

@farhanreynaldo
Copy link
Contributor Author

Thanks @farhanreynaldo

In the future I think it would help to also post the output of

python scripts/validate_docstrings.py pandas.Index.get_loc

which here is

################################################################################
################################## Validation ##################################
################################################################################

5 Errors found:
        No extended summary found
        Parameter "key" has no description
        The first line of the Returns section should contain only the type, unless multiple values are being returned
        Return value has no description
        See Also section not found

to show that the doctests now pass

Thank you for the reminder, @MarcoGorelli, I will add it next time.

@WillAyd WillAyd added the Docs label Mar 4, 2020
@WillAyd WillAyd added this to the 1.1 milestone Mar 4, 2020
@WillAyd WillAyd merged commit bdb4a08 into pandas-dev:master Mar 4, 2020
@WillAyd
Copy link
Member

WillAyd commented Mar 4, 2020

Great thanks @farhanreynaldo for PR and @MarcoGorelli for review

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