Skip to content

DOC: add versionadded specifications to docstrings #10215

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
2 tasks
jorisvandenbossche opened this issue May 27, 2015 · 5 comments
Closed
2 tasks

DOC: add versionadded specifications to docstrings #10215

jorisvandenbossche opened this issue May 27, 2015 · 5 comments
Labels
Milestone

Comments

@jorisvandenbossche
Copy link
Member

We already use the .. versionadded:: directive in the tutorial docs to indicate that a certain feature is only present starting from a specific pandas version.
But I propose that we also start to do this in the docstrings, when adding a new function/method or adding a new keyword to an existing function/method:

So if we agree on this, some todo's:

@jorisvandenbossche
Copy link
Member Author

@jreback @shoyer @sinhrks @TomAugspurger

Any objections to this?
It would look something like this: jorisvandenbossche@274826e

@TomAugspurger
Copy link
Contributor

👍

@jreback
Copy link
Contributor

jreback commented May 29, 2015

lgtm

@sinhrks
Copy link
Member

sinhrks commented May 29, 2015

Nice, will do.

@shoyer
Copy link
Member

shoyer commented May 29, 2015

Agreed, seems like a good idea.

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

5 participants