DOC: Fix GL01 and GL02 errors in the docstrings #27988
Conversation
…and be followed immediately by the line with closing `"""`.
…and be followed immediately by the line with closing `"""`.
|
Hello @steveayers124! 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-08-24 05:57:03 UTC |
…and be followed immediately by the line with closing `"""`.
…and be followed immediately by the line with closing `"""`.
…and be followed immediately by the line with closing `"""`.
datapythonista
changed the title
""" and followed immediately by the line with closing """. Issue #27986
There was a problem hiding this comment.
Good work, thanks for working on these @steveayers124.
I see that the CI is red, and that pep8speaks complaint about couple of lines being too long. Can you check the CI and fix any errors, so everything is green and we can merge please? Thanks!
|
I appreciate your review, and encouragement, @datapythonista. I'll try going in smaller increments to see maybe what's failing, when I try more pull requests on my remaining changes. Thanks for the feedback! |
| @@ -123,18 +123,22 @@ def ip(): | |||
|
|
|||
| @pytest.fixture(params=[True, False, None]) | |||
| def observed(request): | |||
| """ pass in the observed keyword to groupby for [True, False] | |||
| """ | |||
| Pass in the observed keyword to groupby for [True, False] | |||
There was a problem hiding this comment.
I think need a blank line separating short description from long description here
| @@ -234,15 +238,16 @@ def cython_table_items(request): | |||
|
|
|||
|
|
|||
| def _get_cython_table_params(ndframe, func_names_and_expected): | |||
| """combine frame, functions from SelectionMixin._cython_table | |||
| """ | |||
| Combine frame, functions from SelectionMixin._cython_table | |||
There was a problem hiding this comment.
Short description should be one line
|
Agree on both @WillAyd. But I'm also happy to have them in a follow up. GL01 and GL02 are about the position of the quotes, and for formatting errors I'd say it may speed up things if we merge PRs fast and keep opening new tickets fast, than trying to address too many in the PRs. I'm writing a blog post about what I think it makes sense, so we can discuss and find the way that we all find more efficient. But there is so much to say that it's taking forever. :) |
|
Sure - merge away
…Sent from my iPhone
On Aug 24, 2019, at 9:22 AM, Marc Garcia ***@***.***> wrote:
Agree on both @WillAyd. But I'm also happy to have them in a follow up. GL01 and GL02 are about the position of the quotes, and for formatting errors I'd say it may speed up things if we merge PRs fast and keep opening new tickets fast, than trying to address too many in the PRs.
I'm writing a blog post about what I think it makes sense, so we can discuss and find the way that we all find more efficient. But there is so much to say that it's taking forever. :)
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
|
|
Thanks @steveayers124, keep the good work. |
* master: (40 commits) DOC: Fix GL01 and GL02 errors in the docstrings (pandas-dev#27988) Remove Encoding of values in char** For Labels (pandas-dev#27618) TYPING: more type hints for io.formats.printing (pandas-dev#27765) TST: fix compression tests when run without virtualenv/condaenv (pandas-dev#28051) DOC: Start 0.25.2 (pandas-dev#28111) DOC: Fix docstrings lack of punctuation (pandas-dev#28031) DOC: Remove alias for numpy.random.randn from the docs (pandas-dev#28082) DOC: update GroupBy.head()/tail() documentation (pandas-dev#27844) BUG: timedelta merge asof with tolerance (pandas-dev#27650) BUG: Series.rename raises error on values accepted by Series construc… (pandas-dev#27814) Preserve index when setting new column on empty dataframe. (pandas-dev#26471) BUG: Fixed groupby quantile for listlike q (pandas-dev#27827) BUG: iter with readonly values, closes pandas-dev#28055 (pandas-dev#28074) TST: non-strict xfail for period test (pandas-dev#28072) DOC: Update whatsnew (pandas-dev#28073) CI: disable codecov (pandas-dev#28065) CI: Set SHA for codecov upload (pandas-dev#28067) BUG: Correct the previous bug fixing on xlim for plotting (pandas-dev#28059) CI: Add pip dependence explicitly (pandas-dev#28008) DOC: Change document code prun in a row (pandas-dev#28029) ...
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffFixed docstrings text that aren’t on the next line after opening
"""and followed immediately by the line with closing""". Issue #27986