Isort contributing guide #23364
Isort contributing guide #23364
Conversation
doc/source/contributing.rst
Outdated
|
|
||
| isort pandas/io/pytables.py | ||
|
|
||
| to automatically format imports correctly. (Note pass the `--recursive` flag to sort all files in a directory) |
There was a problem hiding this comment.
I'd make the note an additional sentence instead of having it in parenthesis, e.g. something like "The --recursive flag can be passed to sort all files in a directory."
There was a problem hiding this comment.
Perhaps also note what to do if changes are made by isort. Roughly "This will modify the files in your repository. You can then verify that the changes look correct, git add, commit, and push to your branch."
There was a problem hiding this comment.
Thanks guys believe I have now addressed both your comments, let me know if you have anything else to add
Codecov Report
@@ Coverage Diff @@
## master #23364 +/- ##
=======================================
Coverage 92.23% 92.23%
=======================================
Files 161 161
Lines 51197 51197
=======================================
Hits 47220 47220
Misses 3977 3977
Continue to review full report at Codecov.
|
|
I'd also add a link to the PEP-8 section about imports. And may be quickly explain what's the expected order. |
|
@alimcmaster1 can you update with the new isort settings |
|
Yes I’ll be working on this later today |
|
Thanks all for the comments, ive updated let me know what you think. To make reviewing easier here is what it looks like :) |
| @@ -612,6 +612,52 @@ Alternatively, you can install the ``grep`` and ``xargs`` commands via the | |||
| `MinGW <http://www.mingw.org/>`__ toolchain, and it will allow you to run the | |||
| commands above. | |||
|
|
|||
There was a problem hiding this comment.
can you add a ref tag here.
|
@datapythonista - thanks have done - let me know what you think - see here |
There was a problem hiding this comment.
lgtm, just added a comma (literally), that I think helps understand better that sentence. Thanks @alimcmaster1
Co-Authored-By: alimcmaster1 <[email protected]>
|
thanks @alimcmaster1 |
git diff upstream/master -u -- "*.py" | flake8 --diff