Ongoing: Fixing docstrings #2916

ghost · 2013-02-23T20:20:45Z

Just pushed scripts/find_undoc_args.py. putting this here
for the occasional drive-by contributor, and newcomers who would appreciate
an opportunity to make a "low-risk" first PR.

1) pandas/compat/scipy.py:8 (scoreatpercentile()) - Missing[1/4]: ['interpolation_method'] Extra(?): ['interpolation']
2) pandas/core/algorithms.py:105 (factorize()) - Missing[1/4]: ['na_sentinel']
3) pandas/core/format.py:1287 (set_printoptions()) - Missing[3/12]: ['max_colwidth', 'colheader_justify', 'encoding']
4) pandas/core/frame.py:5714 (boxplot()) - Missing[3/6]: ['ax', 'grid', 'rot'] Extra(?): ['data']
5) pandas/core/generic.py:1005 (truncate()) - Missing[1/3]: ['copy']
6) pandas/core/groupby.py:529 (groupby()) - Missing[1/2]: ['by'] Extra(?): ['groupings', 'axis', 'exclusions', 'name', 'level']
7) pandas/core/reshape.py:601 (lreshape()) - Missing[1/4]: ['label']
8) pandas/core/reshape.py:725 (make_axis_dummies()) - Missing[1/3]: ['frame'] Extra(?): ['call']
9) pandas/stats/math.py:93 (calc_F()) - Missing[1/6]: ['R']
10) pandas/stats/moments.py:804 (expanding_apply()) - Missing[1/6]: ['time_rule']
11) pandas/stats/moments.py:721 (expanding_count()) - Missing[1/4]: ['time_rule']
12) pandas/stats/moments.py:741 (expanding_quantile()) - Missing[1/6]: ['time_rule']
13) pandas/stats/moments.py:556 (rolling_apply()) - Missing[1/7]: ['time_rule']
14) pandas/stats/moments.py:128 (rolling_count()) - Missing[1/5]: ['time_rule']
15) pandas/stats/moments.py:528 (rolling_quantile()) - Missing[1/7]: ['time_rule']
16) pandas/stats/moments.py:584 (rolling_window()) - Missing[2/9]: ['time_rule', 'axis']
17) pandas/stats/moments.py:256 (_rolling_moment()) - Missing[1/8]: ['time_rule']
18) pandas/stats/ols.py:1243 (_filter_data()) - Missing[1/3]: ['weights']
19) pandas/tools/plotting.py:96 (scatter_matrix()) - Missing[2/7]: ['marker', 'frame']
20) pandas/tools/plotting.py:1811 (boxplot_frame_groupby()) - Missing[3/7]: ['grouped', 'grid', 'figsize']
21) pandas/tools/plotting.py:1981 (_subplots()) - Missing[1/9]: ['data'] Extra(?): ['fig_kw']
22) pandas/tools/plotting.py:307 (andrews_curves()) - Missing[1/4]: ['ax']
23) pandas/tools/plotting.py:1545 (boxplot()) - Missing[3/8]: ['ax', 'grid', 'figsize']
24) pandas/tools/plotting.py:1671 (hist_frame()) - Missing[3/11]: ['column', 'data', 'by']
25) pandas/tools/plotting.py:1358 (plot_frame()) - Missing[3/24]: ['frame', 'fontsize', 'figsize'] Extra(?): ['barh', 'bar', 'stacked']
26) pandas/tools/plotting.py:1467 (plot_series()) - Missing[1/16]: ['series'] Extra(?): ['barh', 'bar']
27) pandas/tools/tile.py:14 (cut()) - Missing[2/7]: ['include_lowest', 'precision']
28) pandas/tools/tile.py:104 (qcut()) - Missing[1/5]: ['precision']
29) pandas/tseries/frequencies.py:741 (infer_freq()) - Missing[1/2]: ['warn']
30) pandas/tseries/offsets.py:1163 (generate_range()) - Missing[2/5]: ['time_rule', 'offset']
31) pandas/tseries/tools.py:51 (to_datetime()) - Missing[3/6]: ['box', 'dayfirst', 'format']

The text was updated successfully, but these errors were encountered:

wesm · 2013-02-24T23:01:15Z

that is pretty sweet

ghost · 2013-02-25T05:48:40Z

updated with GH task list ftw.

ghost · 2013-02-25T11:42:06Z

Turns out there's a PEP on docstring style, as well as alternatives like epytext, and even some tool support for this very purpose.

DOC: update scipy.py #2916

DOC: Adding parameters to frequencies, offsets (issue #2916)

karmel · 2013-04-22T23:48:19Z

I think 9 and 31 here were previously completed:

pandas/stats/math.py:93 (calc_F()) - Missing[1/6]: ['R']
0dc4f33
pandas/tseries/tools.py:51 (to_datetime()) - Missing[3/6]: ['box', 'dayfirst', 'format']
0f192ea

And the 'label' parameter in 7 does not actually appear to be used in the lreshape function as far as I can tell:
7) pandas/core/reshape.py:601 (lreshape()) - Missing[1/4]: ['label']
https://github.com/pydata/pandas/blob/master/pandas/core/reshape.py#L617

ghost · 2013-04-23T00:08:33Z

Some may just be false positives as the list was generated by a script.
lreshape's commit message calls it "experimental", no harm in leaving it in for now.

Marked all the items you mentioned as done. Thanks.

…andas-dev#2916)

DOC: Adding parameters address issue sub-points 8 and 10 - 24 (issue #2916)

Version 0.11 * tag 'v0.11.0': (75 commits) RLS: Version 0.11 BUG: respect passed chunksize in read_csv when using get_chunk function. close pandas-dev#3406 DOC: Adding parameters to frequencies, offsets (issue pandas-dev#2916) BUG: fix broken validators again Revert "BUG: config.is_one_of_factory is broken" DOC: minor indexing.rst doc updates BUG: config.is_one_of_factory is broken TST: add test for config.is_one_of_factory DOC: RELEASE.rst mention new options disp.height/width and deprecated line_width BUG: fix validators for config options ENH: default dimensions for ip zmq frontends derive from disp.height/width defaults ENH: let display.notebook_repr_html control HTML repr in qtconsole again. ENH: fix df.repr() for scripts (keep GH1611 away), accept None for max_cols/rows BUG: rework get_console_size to handle cases properly ENH: optimize _repr_fits_horizontal_, to_string only on slice of interest BUG: for numerical option, sentry should be another Type, not 0 TST: fix test_repr_non_interactive passing by accident TST: adjust tests to accommodate new defaults for display options ENH: Adjust height/width/max_rows defaults to match informal survey results CLN: convert test utilizing disp.line_width to disp.width ...

lodagro · 2013-06-07T08:10:12Z

fyi @klen added pep257 docstring style checking to the develop branch of his vim plugin python-mode and his code audit tool for python pylama.

Add ax docstring. Address issue generated by `scripts/find_undoc_args.py`.

yyl · 2015-01-19T04:52:44Z

Hi,

I came across this and figured this was a good place for me to get familiar with and start contributing to pandas.

The list seems pretty old as when I click through the line of code of each item in the list, the referred line of code is not there anymore.

I went ahead and used scripts/find_undoc_args.py to identify more similar issues. There were several of them, and I chose one of them to start.

Pull request is here #9293.

Please let me know if this is a proper way to contribute.

Update plotting.py (issue #2916)

shoyer · 2015-01-19T09:35:42Z

@yyl Yes, improvements to documentation/docstrings are always appreciated 👍.

jamesredwards · 2018-03-05T20:00:51Z

Hi, I was hoping to contribute and this looked like somewhere good to start, but I'm having some issues with the script, for example:

./find_undoc_args.py -m pandas -G pandas-dev -p pandas | head -n1

- [ ] 1) [core/algorithms.py:527 (factorize())](https://github.com/pandas-dev/blob/master/core/algorithms.py#L527) -  __Missing__[1/5]: ['order']

any ideas? seem to be using the path flag wrong, but i can't figure it out.
thanks

ProsperousHeart · 2018-04-15T01:29:11Z

I'd like to contribute, but I'm not quite sure what some of the ask is here...

jreback · 2019-01-01T17:28:25Z

closing this as @datapythonista has created new specific issues & we have much better validation to catch things like this.

jseabold mentioned this issue Feb 24, 2013

documenting undocumented arguments statsmodels/statsmodels#685

Closed

ghost pushed a commit that referenced this issue Apr 6, 2013

Merge pull request #3262 from chappers/docstring

16027f9

DOC: update scipy.py #2916

karmel added a commit to karmel/pandas that referenced this issue Apr 22, 2013

DOC: Adding parameters to frequencies, offsets (issue pandas-dev#2916)

d385d25

ghost pushed a commit that referenced this issue Apr 22, 2013

Merge pull request #3420 from karmel/master

5adcceb

DOC: Adding parameters to frequencies, offsets (issue #2916)

ghost mentioned this issue Apr 23, 2013

numpydoc sphinx extension disabled. was: Docstring convention #3431

Closed

karmel added a commit to karmel/pandas that referenced this issue Apr 23, 2013

DOC: Adding parameters address issue sub-points 8 and 10 - 24 (issue p…

f3711cf

…andas-dev#2916)

ghost pushed a commit that referenced this issue Apr 24, 2013

Merge pull request #3422 from karmel/master

0c784e6

DOC: Adding parameters address issue sub-points 8 and 10 - 24 (issue #2916)

ghost mentioned this issue May 1, 2013

TODO: Decorate asserts with helpful messages #3024

Closed

This was referenced Feb 28, 2014

Fixing docstrings openfisca/openfisca-core#122

Closed

Fixing docstrings openfisca/openfisca-qt#10

Closed

Fixing docstrings openfisca/openfisca-qt#21

Closed

jreback mentioned this issue Sep 19, 2014

Bloomberg Hackathon #8323

Closed

yyl added a commit to yyl/pandas that referenced this issue Jan 19, 2015

Update plotting.py (issue pandas-dev#2916)

486f149

Add ax docstring. Address issue generated by `scripts/find_undoc_args.py`.

shoyer added a commit that referenced this issue Jan 19, 2015

Merge pull request #9293 from yyl/quickdocfix

f0922e0

Update plotting.py (issue #2916)

TomAugspurger added the good first issue label Oct 11, 2017

jreback removed the Difficulty Novice label Dec 15, 2017

jreback closed this as completed Jan 1, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ongoing: Fixing docstrings #2916

Ongoing: Fixing docstrings #2916

ghost commented Feb 23, 2013

wesm commented Feb 24, 2013

ghost commented Feb 25, 2013

ghost commented Feb 25, 2013

karmel commented Apr 22, 2013

ghost commented Apr 23, 2013

lodagro commented Jun 7, 2013

yyl commented Jan 19, 2015

shoyer commented Jan 19, 2015

jamesredwards commented Mar 5, 2018

ProsperousHeart commented Apr 15, 2018

jreback commented Jan 1, 2019

Ongoing: Fixing docstrings #2916

Ongoing: Fixing docstrings #2916

Comments

ghost commented Feb 23, 2013

wesm commented Feb 24, 2013

ghost commented Feb 25, 2013

ghost commented Feb 25, 2013

karmel commented Apr 22, 2013

ghost commented Apr 23, 2013

lodagro commented Jun 7, 2013

yyl commented Jan 19, 2015

shoyer commented Jan 19, 2015

jamesredwards commented Mar 5, 2018

ProsperousHeart commented Apr 15, 2018

jreback commented Jan 1, 2019