Skip to content

DOC: Add missing parameters to Series constructor #27960

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

SHuangISU
Copy link

Added documentation to pandas.Series for "name" and "fastpath" parameters.

@pep8speaks
Copy link

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

Line 174:82: W291 trailing whitespace
Line 175:56: W291 trailing whitespace
Line 176:1: W293 blank line contains whitespace
Line 179:1: W293 blank line contains whitespace
Line 180:33: W291 trailing whitespace

@samdbrice
Copy link

  1. You should install this tool on your machine: https://github.com/tj/git-extras
  2. Then make the five changes as instructed by the pep8speaks comment above
  3. Use git squash HEAD~1 to undo the last commit: https://github.com/tj/git-extras/blob/master/Commands.md#git-squash
  4. Do git commit -am "DOC: add API docstrings to pandas.Series for 'name' and 'fastpath'" as per the guidelines: https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#committing-your-code
  5. To override your first commit you'll have to do git push -f that should automatically updat e this PR

@jbrockmendel
Copy link
Member

for what its worth, when merging a PR we squash all commits into one, so its really only step 2 that is needed

@@ -170,8 +170,14 @@ class Series(base.IndexOpsMixin, generic.NDFrame):
Data type for the output Series. If not specified, this will be
inferred from `data`.
See the :ref:`user guide <basics.dtypes>` for more usages.
name : str
This is the variable name of the series. If it in a DataFrame, the column
will be named according to this name parameter.
Copy link
Member

Choose a reason for hiding this comment

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

is the DataFrame sentence relevant? i cant think of a case where that comes up.

The first sentence doesn't need to be a complete sentence: "Name of the Series." is fine

copy : bool, default False
Copy input data.

fastpath: internal paraemter
Copy link
Member

Choose a reason for hiding this comment

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

no newline before this, type it as bool, paraemter--> parameter (on the next line)

@datapythonista datapythonista changed the title added documents DOC: Add missing parameters to Series constructor Aug 19, 2019
@datapythonista datapythonista added Docs Series Series data structure labels Aug 19, 2019
@datapythonista
Copy link
Member

@SHuangISU can you address the review comments please? We've got another PR adding these parameters to this doc, if you're not planning to finish this PR, please let me know, so I'll keep the other one open. Thanks!

@samdbrice
Copy link

@datapythonista - I'd say you could give @SHuangISU 24hrs to respond and if he doesn't get to it you can close this and perhaps point out a similar issue that's available

@datapythonista
Copy link
Member

Thanks for the suggestion @sbrice, but contributors to pandas are volunteers working in their scarce free time, and giving 24h to respond sounds unreasonable and rude to me.

@samdbrice
Copy link

Yeah, the suggestion was within the context of our event i wasn't sure who the other PR was coming from

@datapythonista
Copy link
Member

Ah, that makes sense, didn't get that. Thanks!

@WillAyd
Copy link
Member

WillAyd commented Aug 27, 2019

I think the other PR referenced is #27964 which was updated more recently. I think that one is pretty close so to keep things simple let's close this one out

@SHuangISU certainly would accept any other contributions you'd like to offer

@WillAyd WillAyd closed this Aug 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Series Series data structure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants