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

DOC: resolve all GL03 docstring validation errors #25525

Merged
merged 7 commits into from
Mar 10, 2019

Conversation

jamescobonkerr
Copy link
Contributor

@jamescobonkerr jamescobonkerr commented Mar 3, 2019

Original number of errors: 95
Remaining errors: 0

@codecov
Copy link

codecov bot commented Mar 3, 2019

Codecov Report

Merging #25525 into master will decrease coverage by 50.03%.
The diff coverage is 75%.

Impacted file tree graph

@@             Coverage Diff             @@
##           master   #25525       +/-   ##
===========================================
- Coverage   91.75%   41.71%   -50.04%     
===========================================
  Files         173      173               
  Lines       52960    52960               
===========================================
- Hits        48595    22094    -26501     
- Misses       4365    30866    +26501
Flag Coverage Δ
#multiple ?
#single 41.71% <75%> (ø) ⬆️
Impacted Files Coverage Δ
pandas/io/feather_format.py 89.74% <ø> (ø) ⬆️
pandas/core/base.py 33.33% <ø> (-64.43%) ⬇️
pandas/core/frame.py 34.79% <ø> (-62.07%) ⬇️
pandas/core/generic.py 37.92% <ø> (-56.25%) ⬇️
pandas/plotting/_misc.py 6.93% <ø> (-31.76%) ⬇️
pandas/core/arrays/sparse.py 40.24% <ø> (-51.93%) ⬇️
pandas/core/indexes/base.py 55.72% <ø> (-40.85%) ⬇️
pandas/core/config.py 61.12% <0%> (-25.92%) ⬇️
pandas/core/groupby/base.py 57.14% <100%> (-34.7%) ⬇️
pandas/core/arrays/datetimes.py 65.88% <100%> (-31.92%) ⬇️
... and 141 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 42b4c97...a87f2e6. Read the comment docs.

@codecov
Copy link

codecov bot commented Mar 3, 2019

Codecov Report

Merging #25525 into master will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #25525      +/-   ##
==========================================
- Coverage   91.26%   91.26%   -0.01%     
==========================================
  Files         173      173              
  Lines       52968    52967       -1     
==========================================
- Hits        48340    48338       -2     
- Misses       4628     4629       +1
Flag Coverage Δ
#multiple 89.83% <100%> (-0.01%) ⬇️
#single 41.71% <100%> (ø) ⬆️
Impacted Files Coverage Δ
pandas/io/feather_format.py 89.74% <ø> (ø) ⬆️
pandas/core/groupby/base.py 91.83% <ø> (ø) ⬆️
pandas/core/base.py 97.76% <ø> (ø) ⬆️
pandas/core/frame.py 96.79% <ø> (ø) ⬆️
pandas/core/generic.py 93.65% <ø> (ø) ⬆️
pandas/plotting/_misc.py 38.68% <ø> (ø) ⬆️
pandas/core/config.py 87% <ø> (-0.05%) ⬇️
pandas/core/groupby/groupby.py 97.2% <ø> (ø) ⬆️
pandas/core/arrays/sparse.py 92.17% <ø> (ø) ⬆️
pandas/core/indexes/base.py 96.57% <ø> (ø) ⬆️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cc4a7e5...6e79af0. Read the comment docs.

@jamescobonkerr
Copy link
Contributor Author

Original errors:

pandas.Series.to_numpy: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.agg: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.cummax: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.cummin: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.cumprod: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.cumsum: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.kurt: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.mad: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.median: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.skew: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.kurtosis: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.compound: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.dayofweek: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.weekday: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_month_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_month_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_quarter_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_quarter_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_year_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_year_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.dt.is_leap_year: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.SparseArray: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.read_feather: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.resample.Resampler.apply: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.resample.Resampler.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.resample.Resampler.pipe: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.resample.Resampler.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.cummax: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.cummin: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.cumprod: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.cumsum: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.median: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.skew: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.swaplevel: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.plotting.andrews_curves: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.describe_option: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.reset_option: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.get_option: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.set_option: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.melt: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Index.reindex: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.dayofweek: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.weekday: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_month_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_month_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_quarter_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_quarter_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_year_start: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_year_end: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DatetimeIndex.is_leap_year: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.window.Rolling.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.window.Expanding.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.GroupBy.head: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.GroupBy.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.GroupBy.nth: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.GroupBy.tail: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.corr: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.cov: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.diff: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.fillna: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.hist: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.idxmax: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.idxmin: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.mad: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.skew: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.take: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.tshift: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.nlargest: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.nsmallest: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.unique: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.core.groupby.DataFrameGroupBy.corrwith: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.agg: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.aggregate: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.compound: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.cummax: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.cummin: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.cumprod: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.cumsum: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.kurt: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.kurtosis: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.mad: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.mean: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.median: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.skew: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.DataFrame.to_html: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Series.ptp: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.compound: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.kurt: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.kurtosis: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings
pandas.Panel.mad: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings

@TomAugspurger
Copy link
Contributor

@TomAugspurger
Copy link
Contributor

Actually, those are different errors (PR04). Haven't looked close yet at why those are showing up here.

@TomAugspurger TomAugspurger added this to the 0.25.0 milestone Mar 3, 2019
@jamescobonkerr
Copy link
Contributor Author

Thanks @TomAugspurger . Should be good to go now.

pandas/core/generic.py Outdated Show resolved Hide resolved
pandas/core/generic.py Show resolved Hide resolved
pandas/core/generic.py Outdated Show resolved Hide resolved
pandas/core/groupby/groupby.py Outdated Show resolved Hide resolved
pandas/core/generic.py Show resolved Hide resolved
Copy link
Member

@WillAyd WillAyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TomAugspurger TomAugspurger merged commit 34e8efe into pandas-dev:master Mar 10, 2019
@TomAugspurger
Copy link
Contributor

Thanks!

thoo added a commit to thoo/pandas that referenced this pull request Mar 11, 2019
* upstream/master: (110 commits)
  DOC: hardcode contributors for 0.24.x releases (pandas-dev#25662)
  DOC: restore toctree maxdepth (pandas-dev#25134)
  BUG: Redefine IndexOpsMixin.size, fix pandas-dev#25580. (pandas-dev#25584)
  BUG: to_csv line endings with compression (pandas-dev#25625)
  DOC: file obj for to_csv must be newline='' (pandas-dev#25624)
  Suppress incorrect warning in nargsort for timezone-aware DatetimeIndex (pandas-dev#25629)
  TST: fix incorrect sparse test (now failing on scipy master) (pandas-dev#25653)
  CLN: Removed debugging code (pandas-dev#25647)
  DOC: require Return section only if return is not None nor commentary (pandas-dev#25008)
  DOC:Remove hard-coded examples from _flex_doc_SERIES (pandas-dev#24589) (pandas-dev#25524)
  TST: xref pandas-dev#25630 (pandas-dev#25643)
  BUG: Fix pandas-dev#25481 by fixing the error message in TypeError (pandas-dev#25540)
  Fixturize tests/frame/test_mutate_columns.py (pandas-dev#25642)
  Fixturize tests/frame/test_join.py (pandas-dev#25639)
  Fixturize tests/frame/test_combine_concat.py (pandas-dev#25634)
  Fixturize tests/frame/test_asof.py (pandas-dev#25628)
  BUG: Fix user-facing AssertionError with to_html (pandas-dev#25608) (pandas-dev#25620)
  DOC: resolve all GL03 docstring validation errors (pandas-dev#25525)
  TST: failing wheel building on PY2 and old numpy (pandas-dev#25631)
  DOC: Remove makePanel from docs (pandas-dev#25609) (pandas-dev#25612)
  ...
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.

Fix validation error type GL03 and check in CI
3 participants