Lint rule to catch incorrect sphinx directives #18437
Conversation
| @@ -90,13 +90,26 @@ if [ "$LINT" ]; then | |||
| # | |||
| # Check the following functions: | |||
| # any(), all(), sum(), max(), min(), list(), dict(), set(), frozenset(), tuple(), str.join() | |||
| grep -R --include="*.py*" -E "[^_](any|all|sum|max|min|list|dict|set|frozenset|tuple|join)\(\[.* for .* in .*\]\)" | |||
| grep -R --include="*.py*" -E "[^_](any|all|sum|max|min|list|dict|set|frozenset|tuple|join)\(\[.* for .* in .*\]\)" * | |||
There was a problem hiding this comment.
I added a * in the end because without it this regexp will just wait for stdin (unless linux version works differently. I tried it on mac).
There was a problem hiding this comment.
+1. On Linux, it will grep all directories without the *, but for consistency adding * or . is good.
c08c962 to
1f5508c
Compare
1f5508c to
87aae09
Compare
Codecov Report
@@ Coverage Diff @@
## master #18437 +/- ##
==========================================
- Coverage 91.35% 91.34% -0.02%
==========================================
Files 163 163
Lines 49691 49691
==========================================
- Hits 45397 45388 -9
- Misses 4294 4303 +9
Continue to review full report at Codecov.
|
ci/lint.sh
Outdated
| "seealso|toctree|versionadded|versionchanged|warning" | tr -d "[:space:]") | ||
| for path in './pandas' './doc/source' | ||
| do | ||
| grep -R --include="*.py" --include="*.rst" -E "\.\. ($SPHINX_DIRECTIVES):[^:]" $path |
There was a problem hiding this comment.
could include *.pyx here as well (I don't know if we actually have doc-strings that include directives in cython, but can't hurt).
|
thanks @Scorpil nice patch! |
git diff upstream/master -u -- "*.py" | flake8 --diff