Updated code_checks.sh with PR06 #43511

Varun270 · 2021-09-11T06:18:39Z

[ ✔] closes Fix PR06 issues in docstrings #28724
tests added / passed
[✔ ] Ensure all linting tests pass, see here for how to run them
whatsnew entry

MarcoGorelli

you just need to add PR06, no need to remove any other codes / add blank lines

Varun270 · 2021-09-11T06:39:55Z

you just need to add PR06, no need to remove any other codes / add blank lines

Actually the PR was having merge conflicts so I resolved one, maybe during this process it might have add any kind of space.

MarcoGorelli

please address #43511 (review)

MarcoGorelli

Why did you remove GL02?

Varun270 · 2021-09-12T08:06:42Z

Why did you remove GL02?

Yeah, I really don't know how did that happen. I will fix this asap.

MarcoGorelli · 2021-09-12T13:40:10Z

ci/code_checks.sh

@@ -89,7 +89,7 @@ fi
 ### DOCSTRINGS ###
 if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

-    MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG
+    MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS04, SS05, PR03, PR04, PR05, PR06, 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,PR10,EX04,RT01,RT04,RT05,SA02,SA03


need to add PR06 to this line as well

MarcoGorelli

Looks like there's at least a couple of PR06 errors which still need fixing up

Error: /home/runner/work/pandas/pandas/pandas/core/tools/numeric.py:27:PR06:pandas.to_numeric:Parameter "downcast" type should use "int" instead of "integer"
Error: /home/runner/work/pandas/pandas/pandas/core/arrays/sparse/array.py:248:PR06:pandas.arrays.SparseArray:Parameter "kind" type should use "int" instead of "integer"

Varun270 · 2021-09-13T07:57:42Z

Looks like there's at least a couple of PR06 errors which still need fixing up

Error: /home/runner/work/pandas/pandas/pandas/core/tools/numeric.py:27:PR06:pandas.to_numeric:Parameter "downcast" type should use "int" instead of "integer"
Error: /home/runner/work/pandas/pandas/pandas/core/arrays/sparse/array.py:248:PR06:pandas.arrays.SparseArray:Parameter "kind" type should use "int" instead of "integer"

Here should I change integer to int in both the list and default as well?

mzeitlin11 · 2021-09-13T17:44:51Z

Here should I change integer to int in both the list and default as well?

For the sparse case, "integer" means something different than "int" (is referring to the type of index to construct, not a datatype), so I don't think it should change. Maybe this is a false positive?

MarcoGorelli · 2021-09-13T20:27:29Z

hmm, yeah, this might be a bug in numpydoc..I'll get back to this, might be worth checking if it also happens with the latest release

Varun270 · 2021-09-14T06:33:34Z

Similar thing with downcast parameter, What should I do here @mzeitlin11 ?

mzeitlin11 · 2021-09-14T15:23:19Z

Similar thing with downcast parameter, What should I do here @mzeitlin11 ?

You could look into what @MarcoGorelli was saying above - whether this is an issue with numpydoc that has been fixed in a later release, or if there is some other way to work around it.

Varun270 · 2021-09-14T16:36:09Z

hmm, yeah, this might be a bug in numpydoc..I'll get back to this, might be worth checking if it also happens with the latest release

Till then Can I work on issue#21749

MarcoGorelli · 2021-09-14T17:19:08Z

yes, of course!

Varun270 · 2021-09-14T17:24:05Z

yes, of course!

Please do assign it to me as the bot is not responding to the "take" command.

MarcoGorelli · 2021-09-14T17:26:03Z

multiple people can work on that issue, there's no need to be assigned

github-actions · 2021-10-29T00:03:11Z

This pull request is stale because it has been open for thirty days with no activity. Please update or respond to this comment if you're still interested in working on this.

Varun270 · 2021-10-29T06:11:28Z

@MarcoGorelli This issue has been labeled stale due to inactivity. I was just wondering if there's anything that I have to do or you are handling it from your side.

MarcoGorelli · 2021-10-29T08:40:44Z

Thanks @Varun270 - I haven't had a chance to look at this yet, I'll have a look at whether it needs reporting to NumpyDoc

MarcoGorelli · 2021-11-29T18:17:24Z

I reported this to NumpyDoc in numpy/numpydoc#341

Perhaps we can just work around it with something like

kind : str
    Can be 'integer' or 'block', default is 'integer'.

until/if it's fixed upstream

Varun270 · 2021-11-30T15:00:07Z

I reported this to NumpyDoc in numpy/numpydoc#341

Perhaps we can just work around it with something like
kind : str
    Can be 'integer' or 'block', default is 'integer'.
until/if it's fixed upstream

So should I create a PR to add the changes that you suggested?

MarcoGorelli · 2021-11-30T15:02:13Z

you can update this one

Varun270 · 2021-12-02T07:10:04Z

you can update this one

alright will do it

Varun270 · 2021-12-03T14:23:24Z

@MarcoGorelli I pushed the changes can you tell me what's wrong?

MarcoGorelli

You'll also need to fix downcast

(and fix the merge conflicts)

MarcoGorelli · 2021-12-03T14:49:13Z

pandas/core/tools/numeric.py

@@ -48,7 +48,7 @@ def to_numeric(arg, errors="raise", downcast=None):
        - If 'raise', then invalid parsing will raise an exception.
        - If 'coerce', then invalid parsing will be set as NaN.
        - If 'ignore', then invalid parsing will return the input.
-    downcast : {'integer', 'signed', 'unsigned', 'float'}, default None
+    downcast : {'int', 'signed', 'unsigned', 'float'}, default None


needs to be a fix similar to what you did in pandas/core/arrays/sparse/array.py, this won't work

Okay you mean something like this -

downcast : str Can be 'integer' or 'signed' or 'unsigned' or 'float', default is 'None'.

I'd suggest

downcast : str, default None Can be 'integer', 'signed', 'unsigned', or 'float'.

ci/code_checks.sh

MarcoGorelli · 2021-12-03T15:29:04Z

ci/code_checks.sh

-    MSG='Validate docstrings (GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS03, SS04, SS05, PR03, PR04, PR05, PR08, PRO9, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG
-    $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS03,SS04,SS05,PR03,PR04,PR05,PR08,PR09,PR10,EX04,RT01,RT04,RT05,SA02,SA03
+    MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS04, SS05, PR03, PR04, PR05, PR06, 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,PR06,PR10,EX04,RT01,RT04,RT05,SA02,SA03


I don't think you did the merge quite correctly - can you try again, and make sure that you only add PR06 (and not remove anything else, nor add any blank lines)?

Do you mean I have to add GL01, SS03, PR08, and PR09? Since PR06 is already added.

the diff shows that your PR removes GL01, SS03, PR08, and PR09 - these should not be removed, the only thing this PR should do to this file is to add PR06

ci/code_checks.sh

MarcoGorelli

looks good to me pending green

jreback · 2021-12-05T22:37:37Z

thanks @Varun270

MarcoGorelli · 2021-12-05T22:41:10Z

looks like this wasn't green

Error: /home/runner/work/pandas/pandas/pandas/core/frame.py:1104:PR06:pandas.DataFrame.to_string:Parameter "header" type should use "str" instead of "string"

Varun270 and others added 2 commits September 11, 2021 11:47

Updated code_checks.sh

e9e8779

Merge branch 'master' into Development

a06149a

MarcoGorelli requested changes Sep 11, 2021

View reviewed changes

Varun270 requested a review from MarcoGorelli September 11, 2021 06:40

MarcoGorelli requested changes Sep 11, 2021

View reviewed changes

Varun270 force-pushed the Development branch from 4460d19 to d3bd21b Compare September 12, 2021 07:10

MarcoGorelli requested changes Sep 12, 2021

View reviewed changes

Varun270 force-pushed the Development branch from d3bd21b to 733456a Compare September 12, 2021 13:17

MarcoGorelli requested changes Sep 12, 2021

View reviewed changes

Varun270 force-pushed the Development branch from 733456a to fcce72d Compare September 12, 2021 14:01

Merge branch 'master' into Development

fcce72d

MarcoGorelli requested changes Sep 12, 2021

View reviewed changes

jreback added the Docs label Sep 14, 2021

github-actions bot added the Stale label Oct 29, 2021

Varun270 force-pushed the Development branch from 21ff201 to 943349a Compare December 3, 2021 14:20

MarcoGorelli requested changes Dec 3, 2021

View reviewed changes

Varun270 force-pushed the Development branch from 943349a to 7dab1db Compare December 3, 2021 14:39

MarcoGorelli reviewed Dec 3, 2021

View reviewed changes

Varun270 force-pushed the Development branch from d95d04b to c130470 Compare December 3, 2021 15:14

MarcoGorelli reviewed Dec 3, 2021

View reviewed changes

ci/code_checks.sh Outdated Show resolved Hide resolved

MarcoGorelli requested changes Dec 3, 2021

View reviewed changes

MarcoGorelli changed the title ~~Updated code_checks.sh~~ Updated code_checks.sh with PR06 Dec 4, 2021

Fixed Issue No. pandas-dev#43755

081b555

Varun270 force-pushed the Development branch from 31bad2e to 081b555 Compare December 5, 2021 13:19

Merge branch 'master' into Development

c9fc3fc

MarcoGorelli reviewed Dec 5, 2021

View reviewed changes

ci/code_checks.sh Outdated Show resolved Hide resolved

Update ci/code_checks.sh

05cddd2

MarcoGorelli approved these changes Dec 5, 2021

View reviewed changes

jreback added this to the 1.4 milestone Dec 5, 2021

jreback removed the Stale label Dec 5, 2021

jreback merged commit 2d0fa31 into pandas-dev:master Dec 5, 2021

MarcoGorelli mentioned this pull request Dec 5, 2021

fix PR06 failing CI #44773

Merged

4 tasks

Updated code_checks.sh with PR06 #43511

Updated code_checks.sh with PR06 #43511

Conversation

Varun270 commented Sep 11, 2021

MarcoGorelli left a comment

Choose a reason for hiding this comment

Varun270 commented Sep 11, 2021

MarcoGorelli left a comment

Choose a reason for hiding this comment

MarcoGorelli left a comment

Choose a reason for hiding this comment

Varun270 commented Sep 12, 2021

Choose a reason for hiding this comment

MarcoGorelli left a comment

Choose a reason for hiding this comment

Varun270 commented Sep 13, 2021

mzeitlin11 commented Sep 13, 2021

MarcoGorelli commented Sep 13, 2021

Varun270 commented Sep 14, 2021

mzeitlin11 commented Sep 14, 2021 • edited by MarcoGorelli

Varun270 commented Sep 14, 2021

MarcoGorelli commented Sep 14, 2021

Varun270 commented Sep 14, 2021

MarcoGorelli commented Sep 14, 2021

github-actions bot commented Oct 29, 2021

Varun270 commented Oct 29, 2021

MarcoGorelli commented Oct 29, 2021

MarcoGorelli commented Nov 29, 2021

Varun270 commented Nov 30, 2021

MarcoGorelli commented Nov 30, 2021

Varun270 commented Dec 2, 2021

Varun270 commented Dec 3, 2021

MarcoGorelli left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MarcoGorelli left a comment

Choose a reason for hiding this comment

jreback commented Dec 5, 2021

MarcoGorelli commented Dec 5, 2021

mzeitlin11 commented Sep 14, 2021 •

edited by MarcoGorelli