Skip to content

DOC: Remove flake8 errors for basics.rst and contributing_docstring.rst #24598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jan 4, 2019
Merged

DOC: Remove flake8 errors for basics.rst and contributing_docstring.rst #24598

merged 3 commits into from
Jan 4, 2019

Conversation

@saurav2608
Copy link

@saurav2608 saurav2608 commented Jan 3, 2019

xref: #24173
@jreback
Copy link
Contributor

jreback commented Jan 3, 2019

need to merge master
jreback
jreback reviewed Jan 3, 2019
View reviewed changes
doc/source/basics.rst Outdated
# f, g, and h are functions taking and returning ``DataFrames``
>>> f(g(h(df), arg1=1), arg2=2, arg3=3)
>>> f(g(h(df), arg1=1), arg2=2, arg3=3) # noqa F821
Copy link
Contributor

@jreback jreback Jan 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, this is really ugly, @datapythonista ?
@codecov
Copy link

codecov bot commented Jan 3, 2019

Codecov Report

Merging #24598 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@ Coverage Diff @@ ## master #24598 +/- ## ======================================= Coverage 92.38% 92.38% ======================================= Files 166 166 Lines 52478 52478 ======================================= Hits 48483 48483 Misses 3995 3995
Flag Coverage Δ
#multiple 90.81% <ø> (ø) ⬆️
#single 43.04% <ø> (ø) ⬆️

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 62506ca...bd591d9. Read the comment docs.
@codecov
Copy link

codecov bot commented Jan 3, 2019 •
edited
Loading

Codecov Report

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

Impacted file tree graph

@@ Coverage Diff @@ ## master #24598 +/- ## ========================================== - Coverage 92.38% 92.38% -0.01%  ========================================== Files 166 166 Lines 52478 52490 +12 ========================================== + Hits 48483 48493 +10  - Misses 3995 3997 +2
Flag Coverage Δ
#multiple 90.81% <ø> (ø) ⬆️
#single 43.05% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/nanops.py 94.54% <0%> (-0.37%) ⬇️
pandas/util/testing.py 88% <0%> (-0.1%) ⬇️
pandas/core/strings.py 98.58% <0%> (ø) ⬆️
pandas/core/indexes/accessors.py 91% <0%> (ø) ⬆️
pandas/core/indexes/timedeltas.py 90.22% <0%> (ø) ⬆️
pandas/core/arrays/timedeltas.py 87.99% <0%> (ø) ⬆️
pandas/core/arrays/datetimes.py 98.01% <0%> (ø) ⬆️
pandas/core/frame.py 96.92% <0%> (ø) ⬆️
pandas/core/internals/construction.py 96.67% <0%> (ø) ⬆️
pandas/core/arrays/period.py 98.53% <0%> (+0.01%) ⬆️
... and 3 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 62506ca...be8d253. Read the comment docs.
@jreback jreback added the Docs label Jan 3, 2019
@datapythonista
Copy link
Member

datapythonista commented Jan 4, 2019

Sorry, I wasn't available the last couple of days. That's the reason I didn't create the issues for basics and contributing_docstring, because they are not so simple. Can you just leave the easy changes (all the ones without the noqa (adding np...) here? I'll take care of the remaining myself in a separate PR later.
@jreback jreback added this to the 0.24.0 milestone Jan 4, 2019
@jreback jreback merged commit 2d60af2 into pandas-dev:master Jan 4, 2019
@jreback
Copy link
Contributor

jreback commented Jan 4, 2019

thanks @saurav2608
@saurav2608 saurav2608 deleted the doc_basic_enhan branch January 5, 2019 09:18
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
@saurav-chakravorty @Pingviinituutti
DOC: Remove flake8 errors for basics.rst and contributing_docstring.r…
7d98f07 
…st (pandas-dev#24598)
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
@saurav-chakravorty @Pingviinituutti
DOC: Remove flake8 errors for basics.rst and contributing_docstring.r…
f597a88 
…st (pandas-dev#24598)
@iamshreeram
Copy link

iamshreeram commented Aug 17, 2019

@saurav2608 / @jreback , I still see flake8-rst issues with contributing_docstring.rst. Is it good idea to add # noqa for below issues ?

contributing_docstring.rst:52:9: F821 undefined name 'add' contributing_docstring.rst:54:9: F821 undefined name 'add' contributing_docstring.rst:56:9: F821 undefined name 'add' contributing_docstring.rst:456:16: F821 undefined name 'random' contributing_docstring.rst:476:18: F821 undefined name 'random' contributing_docstring.rst:477:27: F821 undefined name 'random' contributing_docstring.rst:477:41: F821 undefined name 'string' contributing_docstring.rst:498:19: F821 undefined name 'random' contributing_docstring.rst:650:21: F821 undefined name 'pd' contributing_docstring.rst:774:60: F821 undefined name 'numpy' contributing_docstring.rst:832:31: F821 undefined name 'numpy' contributing_docstring.rst:950:9: F821 undefined name 'Substitution' contributing_docstring.rst:951:9: F821 undefined name 'Appender' contributing_docstring.rst:956:9: F821 undefined name 'Substitution' contributing_docstring.rst:957:9: F821 undefined name 'Appender' contributing_docstring.rst:986:5: F821 undefined name 'Appender' contributing_docstring.rst:986:14: F821 undefined name 'template' contributing_docstring.rst:986:25: F821 undefined name '_shared_doc_kwargs'
@datapythonista
Copy link
Member

datapythonista commented Aug 17, 2019

Thanks for offering @iamshreeram, but we may be moving that page our of the docs into the website, so not worth fixing those at this point. You can easily find things to fix in the docstrings, those will be much more useful. ./scripts/validate_docstrings.py should give you lots of errors to fix. :)
@steveayers124
Copy link
Contributor

steveayers124 commented Aug 17, 2019

We're hunting errors to fix, and I'm just getting started, so we appreciate your pointers, @datapythonista !
@steveayers124
Copy link
Contributor

steveayers124 commented Aug 17, 2019

./scripts/validate_docstrings.py
@datapythonista , I'm seeing a lot to sift through to find something I can fix. What advice do you have to point me in the right direction?
@datapythonista
Copy link
Member

datapythonista commented Aug 17, 2019

are you in the Walmart hackathon? how people is communicating there, do you have any IM?
@datapythonista
Copy link
Member

datapythonista commented Aug 17, 2019

Do you think I can get an invitation?
@iamshreeram
Copy link

iamshreeram commented Aug 17, 2019

Please try - http://bit.ly/pandashackslack
@steveayers124
Copy link
Contributor

steveayers124 commented Aug 17, 2019

@datapythonista , are you able to join?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs

6 participants

@saurav2608 @jreback @datapythonista @iamshreeram @steveayers124 @saurav-chakravorty