Docstring GL01 GL02 fixes #26526
Merged
Docstring GL01 GL02 fixes #26526
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hello @killerontherun1! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found: There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻 Comment last updated at 2019-06-19 17:43:19 UTC |
|
Current list of GL01,GL02 after the last 4 commits. This is an attempt to solve at least most of them. |
Codecov Report
@@ Coverage Diff @@
## master #26526 +/- ##
===========================================
- Coverage 91.76% 41.7% -50.06%
===========================================
Files 174 174
Lines 50653 50653
===========================================
- Hits 46482 21127 -25355
- Misses 4171 29526 +25355
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #26526 +/- ##
==========================================
+ Coverage 91.76% 91.76% +<.01%
==========================================
Files 174 174
Lines 50653 50649 -4
==========================================
- Hits 46482 46479 -3
+ Misses 4171 4170 -1
Continue to review full report at Codecov.
|
added 11 commits
May 26, 2019 23:30
|
@killerontherun1 let me know when this is ready for review if not already. If you resolve all of the conflicts should also update the CI rule to check for this code |
|
Thought I might as well just wrap up all the errors while I'm at it. Having
a bit of trouble with pandas.xxxx.dt.*.
Seems to be one document that's off that's causing them across DataFrame,
Series and Panel.
Will get to the bottom of it and complete it. Will tag you here when it's
done.
…On Tue, 28 May, 2019, 11:21 AM William Ayd, ***@***.***> wrote:
@killerontherun1 <https://github.com/killerontherun1> let me know when
this is ready for review if not already. If you resolve all of the
conflicts should also update the CI rule to check for this code
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#26526?email_source=notifications&email_token=AF2JNPHCOVNUGVWZIXDV7WDPXTB7TA5CNFSM4HPWNUQ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODWLBFRA#issuecomment-496374468>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AF2JNPDRTBQ4F32WNVMQP6DPXTB7TANCNFSM4HPWNUQQ>
.
|
|
@WillAyd : Ready for review. Going to let others tackle the rest. There were a total of 540 GL01 and GL02 errors when I started. Have reduced it to 454. |
This is the error when I try to run this. I listed packages and filtered with grep ('doc' )and it seems to be there. |
|
Do you have sphinx installed?
…On Mon, Jun 3, 2019 at 3:08 PM killerontherun1 ***@***.***> wrote:
Run python make.py --single pandas.core.groupby.groupby.GroupBy.sum from
the doc directory and it should generate the HTML files for you to look at
in build/html/reference/api
This is the error when I try to run this.
Traceback (most recent call last): File "make.py", line 22, in <module>
import docutils ModuleNotFoundError: No module named 'docutils'
I listed packages and filtered with grep ('doc' )and it seems to be there.
docker-py 3.5.1 py37_1001 docker-pycreds 0.4.0 py_0 docutils 0.14 py37_0
numpydoc 0.9.1 py_0 pandoc 2.2.3.2 0 pandocfilters 1.4.2 py37_1
This could be a super noob problem (again). Some help would be great.
Would love to wrap this up.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#26526?email_source=notifications&email_token=AAKAOIUAQENI2WX5S4VJX4LPYV247A5CNFSM4HPWNUQ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODW2RMLI#issuecomment-498406957>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAKAOIXLNVR5Z27MEIEUKXTPYV247ANCNFSM4HPWNUQQ>
.
|
|
@killerontherun1 the preferred way to install a development environment is with conda. You can download miniconda and install miniconda, and open a Python terminal with Then, in the pandas repo root you need: and continue from there, you should have an active conda environment with everything you need to build the docs. |
|
Hey Marc,
Thank you. But my environment is created with conda. And yes, my python
version is 3.7. Is there a config or something I can paste to better
describe the problem?
…On Tue, 4 Jun, 2019, 2:51 PM Marc Garcia, ***@***.***> wrote:
@killerontherun1 <https://github.com/killerontherun1> the preferred way
to install a development environment is with conda. You can download
miniconda and install miniconda, and open a Python terminal with python
to make sure the version in your environment is the one you installed it
conda (it should say something like Python 3.7.1 (default, Dec 10 2018,
22:54:23) [MSC v.1915 64 bit (AMD64)] :: Anaconda, Inc. on win32 in the
first line (note the Anaconda, Inc).
Then, in the pandas repo root you need:
$ conda env create
$ source activate pandas-dev
and continue from there, you should have an active conda environment with
everything you need to build the docs.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#26526?email_source=notifications&email_token=AF2JNPCFMIGNZ3QUL2BRVOLPYYX2VA5CNFSM4HPWNUQ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODW36Z2A#issuecomment-498593000>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AF2JNPANVC7A4RF2FXJW5LDPYYX2VANCNFSM4HPWNUQQ>
.
|
|
did you try to open a terminal with your environment active, and |
|
Tried that too while being in the active conda env. It works. (as in docutils imports successfully.)
The conda install works. thanks.
The build file looks like this. Is the black space in the bottom supposed to come?
EDIT (last edit) : Apologies for the wrong screenshot.
<img width="1440" alt="image" src="https://user-images.githubusercontent.com/24417980/59043815-9523c000-889a-11e9-8d1c-04a23caeab57.png">
…On Wed, 5 Jun, 2019, 2:32 PM Marc Garcia, ***@***.***> wrote:
did you try to open a terminal with your environment active, and import
docutils? If that doesn't work, you can manually run conda install
docutils.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#26526?email_source=notifications&email_token=AF2JNPAZEPJEJ3BHRB23JWLPY56JTA5CNFSM4HPWNUQ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODW7CKAQ#issuecomment-499000578>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AF2JNPFEWEIZWMURU5Y6CE3PY56JTANCNFSM4HPWNUQQ>
.
|
|
can you merge master and fixup and checks issues. does this turn on the actual check? or is this a pre-cursor to that? |
|
Sure, I can merge master and fix up any conflicts that arise.
Not sure I fully understood what you mean by that. |
|
Just a precursor. This is targeted towards pandas.core so have to look at and clean up other directories before we can add to CI |
|
Noob question: Do I merge master on my fork, after pulling the latest master from the main repo, or the master as it was when I forked it? |
|
You should have a remote named upstream pointing to the main pandas repo. To keep your branch updated with the latest development version of pandas you should do in your branch: After this, your branch should be the latest development version of pandas plus your changes. You can check it that this is right by: |
|
Have merged master successfully. @datapythonista : Thank you so much for all the help. Would love to take on more stuff if possible. |
datapythonista
approved these changes
Jun 14, 2019
There was a problem hiding this comment.
lgtm, all yours @WillAyd
Thanks @killerontherun1, you can continue with the same error in other directories, until we can add the validation to ci/code_checks.sh and make sure this formatting errors are not reintroduced again. That would be very useful.
|
Looks like a lint / docstring error in CI still |
WillAyd
requested changes
Jun 14, 2019
|
Cool thanks for the last update. Looks like one last CI failure for too many blank lines. If you can clean that up should be good to go |
|
Hey. Know where I can find the blank lines to clear up? |
##[error]pandas/core/arrays/interval.py(1007,): error GL03: pandas.arrays.IntervalArray.to_tuples: Double line break found; please use only one blank line to separate sections or paragraphs, and do not leave blank lines at the end of docstrings |
|
Not sure why this tripped up. The concerned part of the file looks like this. Should I try and revert them back to '\n's? EDIT: Just saw that it was a GL03 error. Shall I solve these also given this PR was for GL01 and GL02? |
|
If you run |
Any clues as to why this is the case? |
|
wrong Python version may be? |
|
Have updated the line break error. |
|
thanks @killerontherun1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GL01and check in CI #25324git diff upstream/master -u -- "*.py" | flake8 --diff