Skip to content

DOC: Fix quotes position in pandas.core #24158

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

Closed
wants to merge 1 commit into from

Conversation

giantpanpan
Copy link

@giantpanpan giantpanpan commented Dec 8, 2018

@pep8speaks
Copy link

Hello @giantpanpan! Thanks for submitting the PR.

Line 7063:80: E501 line too long (80 > 79 characters)

Line 1316:12: W291 trailing whitespace
Line 1327:26: E225 missing whitespace around operator
Line 1330:25: E225 missing whitespace around operator

@jreback
Copy link
Contributor

jreback commented Dec 8, 2018

pls push to the same PR rather than opening new ones

@datapythonista datapythonista changed the title fix issue #24071 DOC: Fix quotes position in pandas.core Dec 8, 2018
@datapythonista
Copy link
Member

Thanks for the PR @giantpanpan

Some general comments:

  • When you open a pull request, in the title you can copy the description of the issue (or write a short summary of what you are fixing.
  • In the description, keep the template we provide. It's a checklist of things that you should check while opening the PR. In this case, as this is only documentation minor fixing, you can ignore the ones about tests and about the whatsnew section. But you should check the one for the issue you're closing and write the issue number on it, and also execute the git command specified, and check it to know that you did it. If you see the comment from pep8speaks, you would find out about those errors before opening the pull request.

Then, regarding the pull request, I think you misunderstood what is the right and what is the wrong format. This is the correct:

def foo():
    """
    Summary of the docstring.

    Returns
    -------
    str
        Explaining what is being returned.
    """

And you shouldn't create docstrings for the methods that don't have them in this same PR (besides that the ones created have some template that I guess your editor added, that is not correct).

I think it probably makes sense to start over again. My recommendation is that:

  • You clone the repository again
  • You create a branch to work on your changes (git checkout -b fixing_quotes)
  • You fix only the issues reported by the command in the issue description
  • You open a new PR

Please let me know if you need any help. You can ask in the issue comments as you did before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Fix quotes position in pandas.core
4 participants