DOC: Fixing flake8 errors in cookbook.rst #23837

saurav2608 · 2018-11-21T11:05:37Z

closes DOC: Fix format of cookbook.rst #23794
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

datapythonista

Great changes, thanks @saurav2608.

I added some comments on things that IMO would make the formatting more consistent and clearer. If you don't mind fixing those.

doc/source/cookbook.rst

datapythonista · 2018-11-21T11:33:04Z

doc/source/cookbook.rst

@@ -105,11 +108,14 @@ Splitting

 .. ipython:: python

-   df = pd.DataFrame(
-        {'AAA' : [4,5,6,7], 'BBB' : [10,20,30,40],'CCC' : [100,50,-30,-50]}); df
+   df = pd.DataFrame({'AAA': [4, 5, 6, 7], 'BBB': [10, 20, 30, 40],


datapythonista · 2018-11-21T11:34:03Z

doc/source/cookbook.rst

+   dflow = df[df.AAA <= 5]
+   dflow
+   dfhigh = df[df.AAA > 5]
+   dfhigh


If those are not being used later, I'd show the result directly, instead of assigning them to a variable first.

datapythonista · 2018-11-21T11:43:13Z

doc/source/cookbook.rst

-   def CumRet(x,y):
-      return x * (1 + y)
+   def CumRet(x, y):
+       return x * (1 + y)

   def Red(x):


use red, I don't think there is a reason to have these functions named as classes

datapythonista · 2018-11-21T11:44:12Z

doc/source/cookbook.rst

+                      u'beyer': [99, 102, 103, 103, 88, 100]},
+                     index=[u'Last Gunfighter', u'Last Gunfighter',
+                            u'Last Gunfighter', u'Paynter', u'Paynter',
+                            u'Paynter'])


You can remove all the u'', we'll be supporting Python 3 only very soon.

datapythonista · 2018-11-21T11:45:16Z

doc/source/cookbook.rst

-   def gm(aDF,Const):
-      v = ((((aDF.A+aDF.B)+1).cumprod())-1)*Const
-      return (aDF.index[0],v.iloc[-1])
+   def gm(aDF, Const):


Can you use df and const instead?

datapythonista · 2018-11-21T11:45:56Z

doc/source/cookbook.rst

-        {u'stratifying_var': np.random.uniform(0, 100, 20),
-         u'price': np.random.normal(100, 5, 20)})
+       {u'stratifying_var': np.random.uniform(0, 100, 20),
+        u'price': np.random.normal(100, 5, 20)})


also can remove the u'' here, and below

datapythonista · 2018-11-21T11:47:47Z

doc/source/cookbook.rst

-      {'height': [60, 70],
-       'weight': [100, 140, 180],
-       'sex': ['Male', 'Female']})
+       {'height': [60, 70],


Minor thing, but if you want to move this to the previous line, this is how in the previous examples is done.

datapythonista · 2018-11-21T11:54:40Z

The CI failed because of doc/source/cookbook.rst:1324:9: E303 too many blank lines (3).

If you can, would be nice to run locally after the fixes:

LINT=1 ./ci/code_checks.sh
flake8-rst doc/source/cookbook.rst

To see that everything is correct, so we can merge.

saurav2608 · 2018-11-21T11:56:27Z

The CI failed because of doc/source/cookbook.rst:1324:9: E303 too many blank lines (3).

If you can, would be nice to run locally after the fixes:
* `LINT=1 ./ci/code_checks.sh`

* `flake8-rst doc/source/cookbook.rst`
To see that everything is correct, so we can merge.

Noted your suggestions @datapythonista . I have submitted another PR as this build failed the tests. I will make all these changes and resubmit. I am closing the PR till these are resolved.

datapythonista · 2018-11-21T12:06:21Z

You don't need to open new PR for every change.

Just make the changes in the branch you used for the PR, commit and push. The PR will be updated, and it make things much easier for us (and for you I think) this way.

datapythonista

Nice, looks great.

Just one comment. And if you don't mind running flake9-rst doc/source/cookbook.rst to double check that we didn't miss anything, that would be great.

datapythonista · 2018-11-21T17:17:05Z

doc/source/cookbook.rst

@@ -533,10 +537,10 @@ Unlike agg, apply's callable is passed a sub-DataFrame which gives you access to

   S = pd.Series([i / 100.0 for i in range(1, 11)])

-   def CumRet(x, y):
+   def cumRet(x, y):


cum_ret would be the Pythonic way to name the function.

Can you also replace the names in the places where the function names are used below.

datapythonista

Looks great, added a couple of comments.

datapythonista · 2018-11-21T18:56:09Z

doc/source/cookbook.rst

@@ -1034,7 +1036,7 @@ You can use the same approach to read all files matching a pattern.  Here is an
 Finally, this strategy will work with the other ``pd.read_*(...)`` functions described in the :ref:`io docs<io>`.

 .. ipython:: python
-    :suppress:
+    :verbatim:


What does :verbatim: does? I assume the suppress made those not appear in the rendered docs, is that still the case?

:verbatim: prevents execution as well. In this case I think I have made a mistake. The decorator should remain suppress.

datapythonista · 2018-11-21T18:57:41Z

doc/source/cookbook.rst

-      return (aDF.index[0],v.iloc[-1])
+   def gm(df, const):
+       v = ((((df.A + df.B) + 1).cumprod()) - 1) * const
+       return (v.iloc[-1])


Suggested change

return (v.iloc[-1])

return v.iloc[-1]

datapythonista · 2018-11-21T18:59:06Z

doc/source/cookbook.rst

@@ -1267,6 +1324,7 @@ The `method` argument within `DataFrame.corr` can accept a callable in addition
    ...     return cov_ab / std_a / std_b
    ...
    ...
+    ...
    >>> df = pd.DataFrame(np.random.normal(size=(100, 3)))
    ...


doesn't seem like this line is required, is it?

This df is reference in a subsequent line.

I mean't the ... in the next line, I don't think that is doing anything.

And I think the validation is failing because of the ... you added before the df = .... Can you remove that and see if that makes the CI green?

Well here goes. One final try. Thanks for the guidance.

saurav2608 · 2018-11-21T19:41:47Z

The tests pass on my local. Not sure why automate test is failing.

datapythonista

Looks good, let's see if the CI ends on green now.

Thanks @saurav2608

doc/source/cookbook.rst

codecov · 2018-11-22T09:52:15Z

Codecov Report

Merging #23837 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #23837      +/-   ##
==========================================
+ Coverage   92.29%   92.29%   +<.01%     
==========================================
  Files         161      161              
  Lines       51497    51498       +1     
==========================================
+ Hits        47528    47530       +2     
+ Misses       3969     3968       -1

Flag	Coverage Δ
#multiple	`90.69% <ø> (ø)`	⬆️
#single	`42.43% <ø> (+0.1%)`	⬆️

Impacted Files	Coverage Δ
pandas/io/parsers.py	`95.29% <0%> (-0.28%)`	⬇️
pandas/io/pytables.py	`92.3% <0%> (-0.05%)`	⬇️
pandas/core/base.py	`97.6% <0%> (-0.01%)`	⬇️
pandas/core/indexes/multi.py	`95.49% <0%> (-0.01%)`	⬇️
pandas/core/generic.py	`96.84% <0%> (-0.01%)`	⬇️
pandas/core/reshape/pivot.py	`96.55% <0%> (ø)`	⬆️
pandas/io/json/normalize.py	`96.87% <0%> (ø)`	⬆️
pandas/io/packers.py	`88.08% <0%> (ø)`	⬆️
pandas/core/util/hashing.py	`98.4% <0%> (ø)`	⬆️
pandas/core/strings.py	`98.58% <0%> (ø)`	⬆️
... and 40 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 4f16dff...d57be90. Read the comment docs.

datapythonista

Thanks for the update @saurav2608, looks great.

@WillAyd?

WillAyd

Just some nits on imports but rest looks fine. Surprised these weren't caught by linter.

doc/source/cookbook.rst

WillAyd · 2018-11-24T15:44:04Z

Thanks @saurav2608 !

saurav and others added 4 commits November 21, 2018 09:39

firt iter on errors

d467a5c

compatible wiht PEP-8 standard

c3c26ea

DOC: compatible wiht PEP-8 standard

27b3245

DOC: PEP8 compatibility for cookbook.rst

01d9826

datapythonista changed the title ~~Cookbook doc~~ DOC: Fixing flake8 errors in cookbook.rst Nov 21, 2018

datapythonista added Docs Code Style Code style, linting, code_checks Clean labels Nov 21, 2018

datapythonista reviewed Nov 21, 2018

View reviewed changes

DOC: PEP8 compatibility for cookbook.rst

2df61db

datapythonista reviewed Nov 21, 2018

View reviewed changes

saurav added 3 commits November 21, 2018 23:34

DOC: PEP8 compatible v3

cd94d8d

DOC: PEP8 compatible v4

085ac5f

DOC: PEP8 compatible v5

ce05dba

datapythonista reviewed Nov 21, 2018

View reviewed changes

DOC: PEP8 compatible v6

acfb29d

datapythonista approved these changes Nov 21, 2018

View reviewed changes

WillAyd requested changes Nov 21, 2018

View reviewed changes

doc/source/cookbook.rst Show resolved Hide resolved

saurav added 2 commits November 22, 2018 10:25

DOC: Modified the order of imports

8cde4a7

DOC: Changed code to iPython and conform to PEP8

8895fde

datapythonista approved these changes Nov 22, 2018

View reviewed changes

datapythonista mentioned this pull request Nov 22, 2018

DOC: Fix format of cookbook.rst #23794

Closed

WillAyd requested changes Nov 23, 2018

View reviewed changes

doc/source/cookbook.rst Show resolved Hide resolved

doc/source/cookbook.rst Show resolved Hide resolved

DOC: PEP8 standards - blank lines in import block

d57be90

WillAyd approved these changes Nov 24, 2018

View reviewed changes

WillAyd merged commit bea9da2 into pandas-dev:master Nov 24, 2018

saurav2608 deleted the cookbook-doc branch November 24, 2018 19:20

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

DOC: Fixing flake8 errors in cookbook.rst (pandas-dev#23837)

2e844dd

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

DOC: Fixing flake8 errors in cookbook.rst (pandas-dev#23837)

daf5556

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Fixing flake8 errors in cookbook.rst #23837

DOC: Fixing flake8 errors in cookbook.rst #23837

saurav2608 commented Nov 21, 2018

datapythonista left a comment

datapythonista Nov 21, 2018

datapythonista Nov 21, 2018

datapythonista Nov 21, 2018

datapythonista Nov 21, 2018

datapythonista Nov 21, 2018

datapythonista Nov 21, 2018

datapythonista Nov 21, 2018

datapythonista commented Nov 21, 2018

saurav2608 commented Nov 21, 2018

datapythonista commented Nov 21, 2018

datapythonista left a comment

datapythonista Nov 21, 2018

datapythonista left a comment

datapythonista Nov 21, 2018

saurav2608 Nov 21, 2018

datapythonista Nov 21, 2018

datapythonista Nov 21, 2018

saurav2608 Nov 21, 2018

datapythonista Nov 21, 2018

saurav2608 Nov 21, 2018

saurav2608 commented Nov 21, 2018

datapythonista left a comment

codecov bot commented Nov 22, 2018 •

edited

Loading

datapythonista left a comment

WillAyd left a comment

WillAyd commented Nov 24, 2018

DOC: Fixing flake8 errors in cookbook.rst #23837

DOC: Fixing flake8 errors in cookbook.rst #23837

Conversation

saurav2608 commented Nov 21, 2018

datapythonista 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

datapythonista commented Nov 21, 2018

saurav2608 commented Nov 21, 2018

datapythonista commented Nov 21, 2018

datapythonista left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

datapythonista 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

saurav2608 commented Nov 21, 2018

datapythonista left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 22, 2018 • edited Loading

Codecov Report

datapythonista left a comment

Choose a reason for hiding this comment

WillAyd left a comment

Choose a reason for hiding this comment

WillAyd commented Nov 24, 2018

codecov bot commented Nov 22, 2018 •

edited

Loading