DOC: Fixing SA04 errors as per #25337 #25354

Sedosa · 2019-02-17T15:08:34Z

closes Fix validation error type SA04 and check in CI #25337
Updated code_checks.sh

Went through every file and included "See Also" reference, PEP8 compliant. According to the "validate_docstring.py" script the were SA04 errors but having checked every file I have been unable to locate them. Assistance may be required.

Implemented feedback from original pull request.

Updated code_checks.sh to reflect changes.

Updated code_checks.sh Amended files where errors appeared

pep8speaks · 2019-02-17T15:09:03Z

Hello @Sedosa! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on March 02, 2019 at 13:25 Hours UTC

jreback · 2019-02-17T17:27:49Z

pls merge master again

codecov · 2019-02-17T18:26:49Z

Codecov Report

Merging #25354 into master will decrease coverage by 50.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           master   #25354       +/-   ##
===========================================
- Coverage   91.73%   41.72%   -50.02%     
===========================================
  Files         173      173               
  Lines       52839    52839               
===========================================
- Hits        48472    22047    -26425     
- Misses       4367    30792    +26425

Flag	Coverage Δ
#multiple	`?`
#single	`41.72% <ø> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/arrays/base.py	`56.39% <ø> (-41.87%)`	⬇️
pandas/core/indexes/accessors.py	`64% <ø> (-27%)`	⬇️
pandas/core/indexes/multi.py	`33.84% <ø> (-61.76%)`	⬇️
pandas/core/computation/eval.py	`14.42% <ø> (-82.7%)`	⬇️
pandas/core/dtypes/dtypes.py	`73.52% <ø> (-22.06%)`	⬇️
pandas/core/base.py	`33.33% <ø> (-64.43%)`	⬇️
pandas/core/resample.py	`23.39% <ø> (-73.84%)`	⬇️
pandas/plotting/_converter.py	`13.91% <ø> (-49.86%)`	⬇️
pandas/io/formats/style.py	`17.49% <ø> (-79.2%)`	⬇️
pandas/core/reshape/reshape.py	`13.36% <ø> (-86%)`	⬇️
... and 169 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 4a20d5b...307c33f. Read the comment docs.

codecov · 2019-02-17T18:26:50Z

Codecov Report

Merging #25354 into master will decrease coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #25354      +/-   ##
==========================================
- Coverage   91.75%   91.73%   -0.02%     
==========================================
  Files         173      173              
  Lines       52955    52849     -106     
==========================================
- Hits        48589    48483     -106     
  Misses       4366     4366

Flag	Coverage Δ
#multiple	`90.3% <100%> (-0.02%)`	⬇️
#single	`41.73% <100%> (+0.01%)`	⬆️

Impacted Files	Coverage Δ
pandas/core/arrays/base.py	`98.25% <ø> (ø)`	⬆️
pandas/core/indexes/accessors.py	`91% <ø> (ø)`	⬆️
pandas/core/computation/eval.py	`97.11% <ø> (ø)`	⬆️
pandas/core/dtypes/dtypes.py	`96.1% <ø> (ø)`	⬆️
pandas/core/base.py	`97.76% <ø> (ø)`	⬆️
pandas/core/resample.py	`97.22% <ø> (ø)`	⬆️
pandas/plotting/_converter.py	`63.76% <ø> (ø)`	⬆️
pandas/core/arrays/datetimes.py	`97.79% <ø> (ø)`	⬆️
pandas/tseries/frequencies.py	`97.7% <ø> (ø)`	⬆️
pandas/core/window.py	`96.4% <ø> (ø)`	⬆️
... and 47 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 ae4db86...517b158. Read the comment docs.

jreback

lgtm. if someone can give a 2nd look to the docstrings would be great. @pandas-dev/pandas-core

datapythonista

Great changes, still need some fixes.

Remove the pandas/validation_errors.json you committed by error`.

If you fixed all the errors of this type, add validation for it to ci/code_checks.py.

In many cases you have a space before the full stop some_func: Its description .. This is wrong, use some_func: Its description. instead.

You have an inconsistent use of third-person present verbs, and infinitive (e.g. Add/Adds, Return/Returns). Use infinitive everywhere (e.g. Add, Return).

pandas/core/arrays/period.py

pandas/core/base.py

pandas/core/groupby/groupby.py

pandas/core/indexes/multi.py

pandas/core/indexes/range.py

pandas/core/reshape/merge.py

pandas/io/json/json.py

Sedosa · 2019-02-20T23:23:16Z

@datapythonista Thank you so much for the feedback! I've implemented the fixes you requested.

Also, With regards to "pandas/core/groupby/groupby.py" I had to alter 4 decorators because the way they were forming the docstring caused several of the SA04 errors.

Please forgive me for the lack of commit messages. Moronic practise on my part.

The may be one error that still fails the SA04 check, however its' location is NaN and I don't know how to approach /find it.

…nce issue in locating it

datapythonista

Many formatting issues, please make sure you double check all the formats before updating the PR. You got all the wrong formats in the comments, you can review yourself that all them are right.

pandas/_libs/tslibs/timedeltas.pyx

pandas/core/accessor.py

pandas/core/arrays/categorical.py

pandas/core/series.py

pandas/core/window.py

pandas/io/formats/style.py

pandas/plotting/_converter.py

Sedosa · 2019-02-26T22:05:45Z

@datapythonista All checks have passed.

jreback

I would like to see you split this PR up. it is very hard to review giant PR's. You can add the check after the changes are merged.

jreback · 2019-03-03T02:03:45Z

ci/code_checks.sh

@@ -241,8 +241,10 @@ fi
 ### DOCSTRINGS ###
 if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

-    MSG='Validate docstrings (GL06, GL07, GL09, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT04, RT05, SA05)' ; echo $MSG
-    $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL06,GL07,GL09,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT04,RT05,SA05
+


can you remove the extra line

jreback · 2019-03-03T02:04:41Z

pandas/core/arrays/base.py

-        numpy.take
-        pandas.api.extensions.take
+        numpy.take: Take elements from an array along an axis.
+        pandas.api.extensions.take: Take elements from an array.


array -> ExtensionArray

jreback · 2019-03-03T02:05:14Z

pandas/core/arrays/categorical.py

+        add_categories: Add new categories.
+        remove_categories: Remove specified categories.
+        remove_unused_categories: Remove unused categories.
+        set_categories: Set new categories inplace.


remove inplace

jreback · 2019-03-03T02:05:33Z

pandas/core/arrays/categorical.py

+        add_categories: Add new categories.
+        remove_categories: Remove specified categories.
+        remove_unused_categories: Remove unused categories.
+        set_categories: Set new categories inplace.


remove inplace and same for others

jreback · 2019-03-03T02:05:49Z

pandas/core/arrays/categorical.py

@@ -1366,7 +1366,8 @@ def memory_usage(self, deep=False):

        See Also
        --------
-        numpy.ndarray.nbytes
+        numpy.ndarray.nbytes: Total bytes consumed by the elements of the
+            array.


array -> numpy array

jreback · 2019-03-03T02:06:22Z

pandas/core/arrays/categorical.py

@@ -1597,8 +1596,9 @@ def sort_values(self, inplace=False, ascending=True, na_position='last'):

        See Also
        --------
-        Categorical.sort
-        Series.sort_values
+        Categorical.sort: Sort the Category inplace by category value.


remove inplace

jreback · 2019-03-03T02:06:42Z

pandas/core/arrays/categorical.py

-        Series.take : Similar method for Series.
-        numpy.ndarray.take : Similar method for NumPy arrays.
+        Series.take: Similar method for Series.
+        numpy.ndarray.take: Similar method for NumPy arrays.


be consistent, either use NumPy of numpy in your edits

jreback · 2019-03-03T02:07:02Z

pandas/core/arrays/categorical.py

-        unique
-        CategoricalIndex.unique
-        Series.unique
+        unique: Hash table-based unique. Uniques are returned in order of


remove Hash table-based unique

say the order of the original is preserved (rather than does not sort)

jreback · 2019-03-03T02:07:41Z

pandas/core/arrays/datetimelike.py

-        numpy.ndarray.min
-        Index.min : Return the minimum value in an Index.
-        Series.min : Return the minimum value in a Series.
+        numpy.ndarray.min: Return the minimum of the Array along


don't capitalize array

jreback · 2019-03-03T02:07:53Z

pandas/core/arrays/datetimelike.py

-        numpy.ndarray.max
-        Index.max : Return the maximum value in an Index.
-        Series.max : Return the maximum value in a Series.
+        numpy.ndarray.max: Return the maximum of an Array


alimcmaster1 · 2019-03-08T23:07:26Z

@Sedosa are you still looking to take this on? Please merge master

gfyoung · 2019-03-08T23:13:28Z

@alimcmaster1 : Per @jreback , the PR needs to be broken up. Given that this has been silent for some time, I would recommend that you submit PR's that take chunks from this one.

WillAyd · 2019-03-19T04:18:16Z

Closing this one as stale - per comments above would certainly accept other PRs in smaller chunks.

Thanks @Sedosa for the effort so far!

Sedosa added 3 commits February 17, 2019 13:56

DOC: Fixing SA04 errors as per #25337

6098e69

DOC: Fixing SA04 errors as per #25338

1baa2e9

Updated code_checks.sh Amended files where errors appeared

Correcting PEP8 violations and merge conflicts

eddb923

Resolved merge conflicts and PEP8 violations

307c33f

Sedosa closed this Feb 17, 2019

Sedosa reopened this Feb 17, 2019

gfyoung added Docs CI Continuous Integration Code Style Code style, linting, code_checks labels Feb 18, 2019

Sedosa added 7 commits February 18, 2019 19:30

last check

7ca1fa4

Merge remote-tracking branch 'upstream/master' into SA04-fix

4566a5f

Fixing more SA04 errors

f942d56

More checks and adjustments relating to SA04 non-compliant docstrings.

763a983

Resolving RT04 test failure

21c2ecb

RT04 fix attempt 2

e84a432

Removing traling whitespace

cde3b51

jreback added this to the 0.25.0 milestone Feb 19, 2019

jreback approved these changes Feb 19, 2019

View reviewed changes

datapythonista requested changes Feb 19, 2019

View reviewed changes

Sedosa added 3 commits February 20, 2019 23:13

*

af7d2f9

*

a9b7c8a

Merge remote-tracking branch 'upstream/master' into SA04-fix

073e345

Sedosa added 3 commits February 20, 2019 23:32

Amending for PEP8 compliance

87841b0

fixing linting check fail

08f312c

linting fix

6572d5f

Sedosa added 2 commits February 21, 2019 08:59

removing validation_error.json

9571487

Found last error in _libs/tslibs/timedeltas.pyx, searched manually he…

55ab7e8

…nce issue in locating it

datapythonista requested changes Feb 21, 2019

View reviewed changes

Sedosa added 3 commits February 22, 2019 12:26

Implementing a lot of formatting changes, and grammatical errors

bcfc295

Merge remote-tracking branch 'upstream/master' into SA04-fix

446ecc8

Fixing indenting and whitespacing issues

2867e13

Merge branch 'master' into SA04-fix

517b158

jreback requested changes Mar 3, 2019

View reviewed changes

jreback removed this from the 0.25.0 milestone Mar 3, 2019

WillAyd closed this Mar 19, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Fixing SA04 errors as per #25337 #25354

DOC: Fixing SA04 errors as per #25337 #25354

Sedosa commented Feb 17, 2019 •

edited

Loading

pep8speaks commented Feb 17, 2019 •

edited

Loading

jreback commented Feb 17, 2019

codecov bot commented Feb 17, 2019

codecov bot commented Feb 17, 2019 •

edited

Loading

jreback left a comment

datapythonista left a comment

Sedosa commented Feb 20, 2019

datapythonista left a comment

Sedosa commented Feb 26, 2019

jreback left a comment

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

jreback Mar 3, 2019

alimcmaster1 commented Mar 8, 2019

gfyoung commented Mar 8, 2019

WillAyd commented Mar 19, 2019

DOC: Fixing SA04 errors as per #25337 #25354

DOC: Fixing SA04 errors as per #25337 #25354

Conversation

Sedosa commented Feb 17, 2019 • edited Loading

pep8speaks commented Feb 17, 2019 • edited Loading

Comment last updated on March 02, 2019 at 13:25 Hours UTC

jreback commented Feb 17, 2019

codecov bot commented Feb 17, 2019

Codecov Report

codecov bot commented Feb 17, 2019 • edited Loading

Codecov Report

jreback left a comment

Choose a reason for hiding this comment

datapythonista left a comment

Choose a reason for hiding this comment

Sedosa commented Feb 20, 2019

datapythonista left a comment

Choose a reason for hiding this comment

Sedosa commented Feb 26, 2019

jreback 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

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

alimcmaster1 commented Mar 8, 2019

gfyoung commented Mar 8, 2019

WillAyd commented Mar 19, 2019

Sedosa commented Feb 17, 2019 •

edited

Loading

pep8speaks commented Feb 17, 2019 •

edited

Loading

codecov bot commented Feb 17, 2019 •

edited

Loading