Skip to content
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

COMPAT: Standardize method signatures #12662

Closed
gfyoung opened this issue Mar 17, 2016 · 1 comment
Closed

COMPAT: Standardize method signatures #12662

gfyoung opened this issue Mar 17, 2016 · 1 comment
Labels
API Design Compat pandas objects compatability with Numpy or Python functions
Milestone

Comments

@gfyoung
Copy link
Member

gfyoung commented Mar 17, 2016

Currently, the parameter for values that one needs to insert into an array-like object such as DataFrame or Series is inconsistent across implementations. For example, base.py surfaces it as key, whereas series.py surfaces it as v.

This issue was identified while fixing an issue for v0.18.1 (xref #12413), but in the interests of maintaining backwards compatibility for a minor release, this change should be made as early as v0.19.0 with the following API comment:

"The signature for searchsorted has changed. It is now searchsorted(self, value, side='left', sorter=None)."

List of functions with signature inconsistencies:
searchsorted
repeat

@jreback
@jorisvandenbossche

@jreback jreback changed the title Standardize searchsorted API COMPAT: Standardize .searchsorted signature Mar 17, 2016
@jreback jreback added the Compat pandas objects compatability with Numpy or Python functions label Mar 17, 2016
@jreback jreback added this to the 0.19.0 milestone Mar 17, 2016
@gfyoung gfyoung changed the title COMPAT: Standardize .searchsorted signature COMPAT: Standardize signatures Apr 6, 2016
@gfyoung gfyoung changed the title COMPAT: Standardize signatures COMPAT: Standardize method signatures Apr 6, 2016
@gfyoung
Copy link
Member Author

gfyoung commented Apr 6, 2016

In my quest to conquer fromnumeric.py incompatibilities, I have come across several other signature inconsistencies that I think also merit addressing. I've updated the original issue to reflect that.

gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 13, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 13, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 13, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 14, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 15, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 16, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 17, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 18, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 18, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 20, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 20, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 22, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 22, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 23, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 25, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 25, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 25, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(key, side='left', sorter=None)

Closes pandas-devgh-12662.
gfyoung added a commit to forking-repos/pandas that referenced this issue Nov 25, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(value, side='left', sorter=None)

Closes pandas-devgh-12662.
jorisvandenbossche pushed a commit that referenced this issue Nov 26, 2016
Standardize the following function signatures:

1) repeat(reps, *args, **kwargs)
2) searchsorted(value, side='left', sorter=None)

Closes gh-12662.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Design Compat pandas objects compatability with Numpy or Python functions
Projects
None yet
Development

No branches or pull requests

2 participants