Skip to content

Docstring for Series missing description on 'fastpath' #6903

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
jess010 opened this issue Apr 17, 2014 · 4 comments
Closed

Docstring for Series missing description on 'fastpath' #6903

jess010 opened this issue Apr 17, 2014 · 4 comments
Labels

Comments

@jess010
Copy link

jess010 commented Apr 17, 2014

The Series docstring does not include any description for the 'fastpath' parameter.

Couldn't find any example on the website that used this parameter, not sure which needs updating: the init definition or the parameters section.

image
image

@jreback
Copy link
Contributor

jreback commented Apr 17, 2014

this an internal parameter

prob should be called _fastpath

would accept a pr to doc this

@jess010
Copy link
Author

jess010 commented Apr 19, 2014

I can own the PR for this. I'm a little mystified though as to the purpose of this parameter, and why the init def'n would contain a variable that the user never modifies.

Are you able to elaborate on this?

@jreback
Copy link
Contributor

jreback commented Apr 19, 2014

it's an internal parameter

create a DataFrame
select a series
insert as a column to the frame
it's already created so it can be fastpathed and avoid some overhead

it doesn't matter to the user except perf wise
user shouldn't touch it

you'll have to explore the internals

@jreback
Copy link
Contributor

jreback commented May 5, 2014

pls submit a PR if you'd like

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

No branches or pull requests

3 participants