DOC: Fixes to the docs style #24182
DOC: Fixes to the docs style #24182
Conversation
Codecov Report
@@ Coverage Diff @@
## master #24182 +/- ##
==========================================
- Coverage 92.21% 92.21% -0.01%
==========================================
Files 162 162
Lines 51723 51723
==========================================
- Hits 47695 47694 -1
- Misses 4028 4029 +1
Continue to review full report at Codecov.
|
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #24182 +/- ##
==========================================
- Coverage 92.21% 92.21% -0.01%
==========================================
Files 162 162
Lines 51723 51723
==========================================
- Hits 47695 47694 -1
- Misses 4028 4029 +1
Continue to review full report at Codecov.
|
| ignore = E402, # module level import not at top of file | ||
| W503, # line break before binary operator | ||
| # Classes/functions in different blocks can generate those errors |
There was a problem hiding this comment.
@datapythonista why are you adding these? we want to error these, yes?
There was a problem hiding this comment.
Not in the documentation. flake8-rst merges all the blocks in a single file to validate it. Meaning that if I have a block of code that shows a class definition, if we validate for those errors, we will get an error, as the class definition will be immediately after the last statement of the previous block.
There was a problem hiding this comment.
ok thanks. maybe add what you just wrote in a future PR as a reader would have no idea how this works.
There was a problem hiding this comment.
I tried to explain in the comment before skipping the errors, but obviously not clear enough. Will add more context/info in a future PR.
|
thanks @datapythonista |
Fixing flake8 errors in documentation pages that are mostly correct. Also changing
setup.cfgto avoid false positives.git diff upstream/master -u -- "*.py" | flake8 --diff