DOC: Use only one blank line to separate sections or paragraphs

[alexander-ponomaroff]

When checking for errors with ./scripts/validate_docstrings.py, There is an error that comes up:

GL03
Use only one blank line to separate sections or paragraphs

I started working on this and will create a pull request for this issue shortly to go into more detail on what I fixed.

@datapythonista

[datapythonista]

Reopening. Most of the issues have been fixed, but still some left, see: #23871 (comment)

[abkosar]

Hey @datapythonista, I am new to open source and would like to work on this! Just curious if someone is working on it? If not I can give it a shot!

Thanks!

[datapythonista]

I think this is trickier than it looks, but surely a good first issue, and you can definitely work on it.

Executing ./scripts/validate_docstrings.py --errors=GL03 should give you the errors, and should return nothing once you fixed this issue.

Thanks @abkosar

[abkosar]

Thanks!

[abkosar]

So started working on the issue. When I run ./scripts/validate_docstrings.py --errors=GL03 there are 98 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.Timedelta: 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.Timedelta.max: 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.Timedelta.min: 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

[NatholBMX]

Hi @abkosar
Have you mady any progress on this?

[abkosar]

Hi @NatholBMX

I recently started working on this again. I would still like to work on it and sorry for not updating it for a long time.