DOC: Use triple double-quoted strings for docstrings. #1700
Conversation
|
Hello @jhlegarreta, Thank you for updating !
Cheers ! There are no PEP8 issues in this Pull Request. 🍻 Comment last updated on December 24, 2018 at 22:40 Hours UTC |
|
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. |
|
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. |
|
Let's see how 0487ec2 behaves. |
|
The reported test failure is related to #1698. |
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.*
Fix PEP8 warnings.
jhlegarreta
force-pushed
the
UseTripleDoubleQuotesForDocstrings
branch
from
0487ec2
to
edaee10
Compare
Codecov Report
@@ 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
|
|
Thank you @jhlegarreta, merging |
Fix
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.