Skip to content
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.

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

DOC: Use triple double-quoted strings for docstrings. #1700

Merged
merged 2 commits into from Dec 30, 2018

Conversation

@jhlegarreta
Copy link
Contributor

commented Dec 24, 2018

Fix

Triple double-quoted strings should be used for docstrings.

PEP8 warning.

Indeed, according to
https://www.python.org/dev/peps/pep-0008/

For triple-quoted strings, always use double quote characters to be
consistent with the docstring convention in PEP 257.

@pep8speaks

This comment has been minimized.

Copy link

commented Dec 24, 2018

Hello @jhlegarreta, Thank you for updating !

  • Complete extra results for this file :

file_to_check.py:1832:-228: W605 invalid escape sequence '\p'file_to_check.py:1832:-216: W605 invalid escape sequence '\p'file_to_check.py:1853:-230: W605 invalid escape sequence '\p'file_to_check.py:1853:-218: W605 invalid escape sequence '\p'file_to_check.py:1877:-232: W605 invalid escape sequence '\p'file_to_check.py:1877:-218: W605 invalid escape sequence '\p'---

  • Complete extra results for this file :

file_to_check.py:539:-654: W605 invalid escape sequence '\l'file_to_check.py:572:-719: W605 invalid escape sequence '\l'---

  • Complete extra results for this file :

file_to_check.py:75:-630: W605 invalid escape sequence '.'file_to_check.py:75:-196: W605 invalid escape sequence '.'file_to_check.py:75:-184: W605 invalid escape sequence '.'file_to_check.py:388:-88: W605 invalid escape sequence '.'---

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on December 24, 2018 at 22:40 Hours UTC
@arokem

This comment has been minimized.

Copy link
Member

commented Dec 24, 2018

Thanks for doing this @jhlegarreta! As you can see, this triggered a more thorough PEP8 checking on every file you touched. Do you want to go ahead and fix these issues as well, while we're here? If you don't, I can also just merge this one as soon as the CI finishes. It all looks good to me.

@jhlegarreta

This comment has been minimized.

Copy link
Contributor Author

commented Dec 24, 2018

I think it is fair to address them here so that we avoid cyclic warnings if trying to address them in another topic. I'll push another commit shortly.

@jhlegarreta

This comment has been minimized.

Copy link
Contributor Author

commented Dec 24, 2018

Let's see how 0487ec2 behaves.

@jhlegarreta

This comment has been minimized.

Copy link
Contributor Author

commented Dec 25, 2018

The reported test failure is related to #1698.

jhlegarreta added 2 commits Dec 24, 2018
DOC: Use triple double-quoted strings for docstrings.
Fix
```
Triple double-quoted strings should be used for docstrings.
```

PEP8 warning.

Indeed, according to
https://www.python.org/dev/peps/pep-0008/

*For triple-quoted strings, always use double quote characters to be
consistent with the docstring convention in PEP 257.*
STYLE: Fix PEP8 warnings.
Fix PEP8 warnings.

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:UseTripleDoubleQuotesForDocstrings branch from 0487ec2 to edaee10 Dec 30, 2018

@codecov-io

This comment has been minimized.

Copy link

commented Dec 30, 2018

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1700      +/-   ##
==========================================
+ Coverage   84.26%   84.27%   +<.01%     
==========================================
  Files         114      114              
  Lines       13556    13556              
  Branches     2139     2139              
==========================================
+ Hits        11423    11424       +1     
  Misses       1637     1637              
+ Partials      496      495       -1
Impacted Files Coverage Δ
dipy/testing/__init__.py 72.72% <ø> (ø) ⬆️
dipy/testing/spherepoints.py 100% <ø> (ø) ⬆️
dipy/align/imwarp.py 98.39% <ø> (ø) ⬆️
dipy/tracking/learning.py 100% <ø> (ø) ⬆️
dipy/io/pickles.py 100% <ø> (ø) ⬆️
dipy/align/imaffine.py 91.53% <ø> (ø) ⬆️
dipy/core/sphere_stats.py 59.01% <ø> (ø) ⬆️
dipy/tracking/eudx.py 94.11% <ø> (ø) ⬆️
dipy/core/profile.py 30% <ø> (ø) ⬆️
dipy/core/graph.py 75% <ø> (+1.19%) ⬆️
... and 9 more
@skoudoro

This comment has been minimized.

Copy link
Member

commented Dec 30, 2018

Thank you @jhlegarreta, merging

@skoudoro skoudoro merged commit 728be22 into nipy:master Dec 30, 2018

4 checks passed

codecov/patch Coverage not affected when comparing 58393aa...edaee10
Details
codecov/project 84.27% (+<.01%) compared to 58393aa
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@jhlegarreta jhlegarreta deleted the jhlegarreta:UseTripleDoubleQuotesForDocstrings branch Dec 30, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.