validate PR09 errors #44524

soumyasomasundaran · 2021-11-19T12:01:16Z

closes #xxxx
tests added / passed
Ensure all linting tests pass, see here for how to run them
whatsnew entry

MarcoGorelli

Thanks @soumyas567 , looks good to me pending green

MarcoGorelli

Actually, looks like there's still a few of these validations which need fixing up:

Error: /home/runner/work/pandas/pandas/pandas/core/frame.py:7703:PR09:pandas.DataFrame.groupby:Parameter "dropna" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/core/generic.py:10955:PR09:pandas.DataFrame.rolling:Parameter "closed" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style.py:82:PR09:pandas.io.formats.style.Styler:Parameter "escape" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style_render.py:786:PR09:pandas.io.formats.style.Styler.format:Parameter "decimal" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style_render.py:786:PR09:pandas.io.formats.style.Styler.format:Parameter "thousands" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style_render.py:983:PR09:pandas.io.formats.style.Styler.format_index:Parameter "decimal" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style_render.py:983:PR09:pandas.io.formats.style.Styler.format_index:Parameter "thousands" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style.py:3136:PR09:pandas.io.formats.style.Styler.highlight_quantile:Parameter "color" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style.py:2760:PR09:pandas.io.formats.style.Styler.bar:Parameter "props" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style.py:466:PR09:pandas.io.formats.style.Styler.to_latex:Parameter "position" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/parquet.py:437:PR09:pandas.read_parquet:Parameter "path" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/sql.py:330:PR09:pandas.read_sql_query:Parameter "dtype" description should finish with "."
Error: None:None:PR09:pandas.Timestamp:Parameter "fold" description should finish with "."
Error: None:None:PR09:pandas.Timestamp.max:Parameter "fold" description should finish with "."
Error: None:None:PR09:pandas.Timestamp.min:Parameter "fold" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/core/series.py:1787:PR09:pandas.Series.groupby:Parameter "dropna" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/core/generic.py:10955:PR09:pandas.Series.rolling:Parameter "closed" description should finish with "."

Do you want to add those full stops, so that the validation script passes?

soumyasomasundaran · 2021-11-19T13:31:21Z

Actually, looks like there's still a few of these validations which need fixing up:

Error: /home/runner/work/pandas/pandas/pandas/core/frame.py:7703:PR09:pandas.DataFrame.groupby:Parameter "dropna" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/core/generic.py:10955:PR09:pandas.DataFrame.rolling:Parameter "closed" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style.py:82:PR09:pandas.io.formats.style.Styler:Parameter "escape" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style_render.py:786:PR09:pandas.io.formats.style.Styler.format:Parameter "decimal" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style_render.py:786:PR09:pandas.io.formats.style.Styler.format:Parameter "thousands" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style_render.py:983:PR09:pandas.io.formats.style.Styler.format_index:Parameter "decimal" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style_render.py:983:PR09:pandas.io.formats.style.Styler.format_index:Parameter "thousands" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style.py:3136:PR09:pandas.io.formats.style.Styler.highlight_quantile:Parameter "color" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style.py:2760:PR09:pandas.io.formats.style.Styler.bar:Parameter "props" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/formats/style.py:466:PR09:pandas.io.formats.style.Styler.to_latex:Parameter "position" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/parquet.py:437:PR09:pandas.read_parquet:Parameter "path" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/io/sql.py:330:PR09:pandas.read_sql_query:Parameter "dtype" description should finish with "."
Error: None:None:PR09:pandas.Timestamp:Parameter "fold" description should finish with "."
Error: None:None:PR09:pandas.Timestamp.max:Parameter "fold" description should finish with "."
Error: None:None:PR09:pandas.Timestamp.min:Parameter "fold" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/core/series.py:1787:PR09:pandas.Series.groupby:Parameter "dropna" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/core/generic.py:10955:PR09:pandas.Series.rolling:Parameter "closed" description should finish with "."

Do you want to add those full stops, so that the validation script passes?

Yes I will do that.

soumyasomasundaran · 2021-11-19T14:39:34Z

I have added full stops. But Sorry not able to find 5 of them.

Don't know where to look for the following.
Error: None:None:PR09:pandas.Timestamp:Parameter "fold" description should finish with "."
Error: None:None:PR09:pandas.Timestamp.max:Parameter "fold" description should finish with "."
Error: None:None:PR09:pandas.Timestamp.min:Parameter "fold" description should finish with "."

could not find a description for parameter 'closed' in the particular file.
Error: /home/runner/work/pandas/pandas/pandas/core/generic.py:10955:PR09:pandas.Series.rolling:Parameter "closed" description should finish with "."
Error: /home/runner/work/pandas/pandas/pandas/core/generic.py:10955:PR09:pandas.DataFrame.rolling:Parameter "closed" description should finish with "."

phofl · 2021-11-19T15:04:17Z

First three are in timestamps.pyx

phofl · 2021-11-19T15:07:51Z

The others are probably in rolling.py in for class Window

MarcoGorelli · 2021-11-19T18:34:38Z

Yeah, groupby is here

pandas/pandas/core/shared_docs.py

Lines 126 to 129 in 945c9ed

    
           dropna : bool, default True 
        
               If True, and if group keys contain NA values, NA values together 
        
               with row/column will be dropped. 
        
               If False, NA values will also be treated as the key in groups

Window:

pandas/pandas/core/window/rolling.py

Lines 895 to 909 in 59d031f

    
               closed : str, default None 
        
                   If ``'right'``, the first point in the window is excluded from calculations. 
        
                   If ``'left'``, the last point in the window is excluded from calculations. 
        
                   If ``'both'``, the no points in the window are excluded from calculations. 
        
                   If ``'neither'``, the first and last points in the window are excluded 
        
                   from calculations. 
        
                   Default ``None`` (``'right'``) 
        
                   .. versionchanged:: 1.2.0 
        
                       The closed parameter with fixed windows is now supported.

Admittedly these aren't the easiest to find

MarcoGorelli

Looks good to me, thanks @soumyas567 !

cc @attack68 in case you have comments on the to_latex change

attack68 · 2021-11-20T09:16:07Z

pandas/io/formats/style.py

@@ -504,7 +504,7 @@ def to_latex(
        position : str, optional
            The LaTeX positional argument (e.g. 'h!') for tables, placed in location:

-            \\begin{table}[<position>]
+            \\begin{table}[<position>].


I don't like this because this line is structured to reflect a console output and shouldn't include the period. The colons are the punctuation indicating a figure that follows (even if the figure is text)

Perhaps it should be written as:

``\begin{table}[<position>]``.

(with 2 backticks before and after) then, to make clear that the full stop isn't part of the console output?

Thanks. Sure I will do it.

attack68 · 2021-11-20T09:16:53Z

One comment made, all others are fine with me.

jreback · 2021-11-20T15:57:16Z

pls also merge master

MarcoGorelli · 2021-11-20T16:13:06Z

pls also merge master

@soumyas567 in case it's not clear:

git fetch upstream
git merge upstream/master
git push origin HEAD

…ate-docstrings

soumyasomasundaran · 2021-11-21T10:21:45Z

I am not sure if the merging was correct. Hopefully, I did not mess it up. @MarcoGorelli

lithomas1 · 2021-11-23T03:07:56Z

@soumyas567 Thanks for the PR. Can you fix up the merge conflict? We'll get it merged afterwards.

MarcoGorelli · 2021-11-23T07:20:45Z

I am not sure if the merging was correct. Hopefully, I did not mess it up. @MarcoGorelli

Yup, the merging was correct!

There have since been new changes upstream, so you'll need to pull these too:

git fetch upstream
git merge upstream/master

and then resolve the merge conflicts (if it's not something you're familiar with, check out https://youtu.be/xNVM5UxlFSA)

MarcoGorelli

This isn't quite right - if you click "files changed", you see

<<<<<<< HEAD
    MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS04, SS05, PR03, PR04, PR05, PR09, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG
    $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS04,SS05,PR03,PR04,PR05,PR09,PR10,EX04,RT01,RT04,RT05,SA02,SA03
=======
    MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS03, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG
    $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS03,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA02,SA03
>>>>>>> upstream/master
    RET=$(($RET + $?)) ; echo $MSG "DONE"

I'd suggest removing the top part (between <<<<<<< HEAD and =======), adding PR09 to the lines below them, and then removing the >>>>>>> upstream/master line

soumyasomasundaran · 2021-11-23T11:34:35Z

This isn't quite right - if you click "files changed", you see

<<<<<<< HEAD
    MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS04, SS05, PR03, PR04, PR05, PR09, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG
    $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS04,SS05,PR03,PR04,PR05,PR09,PR10,EX04,RT01,RT04,RT05,SA02,SA03
=======
    MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS03, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG
    $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS03,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA02,SA03
>>>>>>> upstream/master
    RET=$(($RET + $?)) ; echo $MSG "DONE"

I'd suggest removing the top part (between <<<<<<< HEAD and =======), adding PR09 to the lines below them, and then removing the >>>>>>> upstream/master line

Shall I do this from GitHub itself? I think I did "'keep both changes" while resolving conflicts . My local repository seems up-to-date now.

MarcoGorelli · 2021-11-23T11:43:43Z

Up to you, if you want to do it from the GitHub UI or in your editor

If you do it on GitHub, make sure to then do git pull so your local branch is up-to-date

soumyasomasundaran · 2021-11-23T11:51:46Z

Up to you, if you want to do it from the GitHub UI or in your editor

If you do it on GitHub, make sure to then do git pull so your local branch is up-to-date

Is it OK now?

MarcoGorelli

looks good to me, let's just wait on @attack68 to confirm if the to_latex output looks alright like this

attack68 · 2021-11-23T12:47:52Z

lgtm

MarcoGorelli · 2021-11-23T14:01:17Z

Thanks @soumyas567

soumyasomasundaran · 2021-11-23T15:29:06Z

Thank you all. :) Thank you for the help @MarcoGorelli

validate PR09 errors

352102d

MarcoGorelli added the Docs label Nov 19, 2021

MarcoGorelli added this to the 1.4 milestone Nov 19, 2021

MarcoGorelli approved these changes Nov 19, 2021

View reviewed changes

MarcoGorelli suggested changes Nov 19, 2021

View reviewed changes

MarcoGorelli removed this from the 1.4 milestone Nov 19, 2021

fullstops Added

0d038f5

timestamps.pyx updated with a fullstop

b51467b

full stop added to rolling.py and shared_docs.py

c18d8a0

MarcoGorelli added this to the 1.4 milestone Nov 19, 2021

phofl approved these changes Nov 19, 2021

View reviewed changes

MarcoGorelli approved these changes Nov 19, 2021

View reviewed changes

attack68 reviewed Nov 20, 2021

View reviewed changes

soumyasomasundaran added 2 commits November 21, 2021 09:32

backticks added to Latex position argument

bd6864c

Merge remote-tracking branch 'upstream/master' into add-pr09-to-valid…

9c302ae

…ate-docstrings

Merge conflicts resolved

3e9120c

MarcoGorelli suggested changes Nov 23, 2021

View reviewed changes

merge_conflict_resolved_PRO9

c6001cd

remove extra blank line

841c0ee

MarcoGorelli approved these changes Nov 23, 2021

View reviewed changes

MarcoGorelli merged commit 8bd9f64 into pandas-dev:master Nov 23, 2021

Uh oh!

validate PR09 errors #44524

validate PR09 errors #44524

Uh oh!

Conversation

soumyasomasundaran commented Nov 19, 2021

Uh oh!

MarcoGorelli left a comment

Choose a reason for hiding this comment

Uh oh!

MarcoGorelli left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

soumyasomasundaran commented Nov 19, 2021

Uh oh!

soumyasomasundaran commented Nov 19, 2021

Uh oh!

phofl commented Nov 19, 2021

Uh oh!

phofl commented Nov 19, 2021

Uh oh!

MarcoGorelli commented Nov 19, 2021

Uh oh!

MarcoGorelli left a comment

Choose a reason for hiding this comment

Uh oh!

attack68 Nov 20, 2021

Choose a reason for hiding this comment

Uh oh!

MarcoGorelli Nov 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

soumyasomasundaran Nov 21, 2021

Choose a reason for hiding this comment

Uh oh!

attack68 commented Nov 20, 2021

Uh oh!

jreback commented Nov 20, 2021

Uh oh!

MarcoGorelli commented Nov 20, 2021

Uh oh!

soumyasomasundaran commented Nov 21, 2021

Uh oh!

lithomas1 commented Nov 23, 2021

Uh oh!

MarcoGorelli commented Nov 23, 2021

Uh oh!

MarcoGorelli left a comment

Choose a reason for hiding this comment

Uh oh!

soumyasomasundaran commented Nov 23, 2021

Uh oh!

MarcoGorelli commented Nov 23, 2021

Uh oh!

soumyasomasundaran commented Nov 23, 2021

Uh oh!

MarcoGorelli left a comment

Choose a reason for hiding this comment

Uh oh!

attack68 commented Nov 23, 2021

Uh oh!

MarcoGorelli commented Nov 23, 2021

Uh oh!

soumyasomasundaran commented Nov 23, 2021

Uh oh!

Uh oh!

MarcoGorelli left a comment •

edited

Loading

MarcoGorelli Nov 20, 2021 •

edited

Loading