Skip to content

Add examples for pandas.*.sample #11883

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

Merged
merged 1 commit into from
Dec 23, 2015
Merged

Add examples for pandas.*.sample #11883

merged 1 commit into from
Dec 23, 2015

Conversation

proinsias
Copy link
Contributor

The following doc files are generated from the sample() function from
pandas/core/generic.py:

pandas.DataFrame.sample.html
pandas.Panel.sample.html
pandas.Panel4D.sample.html
pandas.Series.sample.html

Examples for each have been added to the sample() function docstring.

@shoyer
Copy link
Member

shoyer commented Dec 22, 2015

This looks great, but I would drop the examples for Panel and Panel4D. These structures (especially Panel4D) are rarely used, so including them adds noise.

@jorisvandenbossche jorisvandenbossche added this to the 0.18.0 milestone Dec 22, 2015
The following doc files are generated from the sample() function from
pandas/core/generic.py:

pandas.DataFrame.sample.html
pandas.Series.sample.html
pandas.Panel.sample.html
pandas.Panel4D.sample.html

Examples have been added to the sample() function docstring for only
the first two objects, since the latter two are rarely used.
@proinsias
Copy link
Contributor Author

Done!

@shoyer
Copy link
Member

shoyer commented Dec 23, 2015

This looks good to me -- anyone else have any comments before I merge?

@jorisvandenbossche
Copy link
Member

Yep, thanks!

jorisvandenbossche added a commit that referenced this pull request Dec 23, 2015
@jorisvandenbossche jorisvandenbossche merged commit 49b2660 into pandas-dev:master Dec 23, 2015
@proinsias proinsias deleted the core.generic.sample branch December 23, 2015 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants