-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
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
Conversation
Hello @SHuangISU! Thanks for opening this PR. We checked the lines you've touched for PEP 8 issues, and found:
|
|
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. |
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.
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 |
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.
no newline before this, type it as bool, paraemter--> parameter (on the next line)
@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! |
@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 |
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. |
Yeah, the suggestion was within the context of our event i wasn't sure who the other PR was coming from |
Ah, that makes sense, didn't get that. Thanks! |
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 |
Added documentation to pandas.Series for "name" and "fastpath" parameters.