Added a check for standard documentation #33592
Conversation
|
The CI is failing because of trailing whitespace in the code check file |
| fi | ||
| done | ||
|
|
||
| exit $RET |
There was a problem hiding this comment.
think you need a newline here
There was a problem hiding this comment.
Sorry I'm not too sure what you mean, I'm new to this. Do you want me to add a new line after done?
There was a problem hiding this comment.
Do you want me to add a new line after done?
yes please
There was a problem hiding this comment.
I have added a new line after done as requested!
There was a problem hiding this comment.
@willie3838 think you added the new line in the wrong spot. Should come at the end of this line not preceding
There was a problem hiding this comment.
@willie3838 think you added the new line in the wrong spot. Should come at the end of this line not preceding
I have added your solution, let me know if it still does not resolve the issue.
There was a problem hiding this comment.
There needs to be a newline at the end of this file
ci/code_checks.sh
Outdated
| @@ -378,4 +378,13 @@ if [[ -z "$CHECK" || "$CHECK" == "typing" ]]; then | |||
| fi | |||
|
|
|||
|
|
|||
| ### Checking for standardized documentation ### | |||
| echo "Checking which files in pandas/doc/source have standardized documentation" | |||
There was a problem hiding this comment.
I think this check should go under the ### PATTERNS ### further up this file.
Could you also follow the pattern those checks have?
| @@ -237,6 +237,14 @@ if [[ -z "$CHECK" || "$CHECK" == "patterns" ]]; then | |||
| invgrep -RI --exclude=\*.{svg,c,cpp,html,js} --exclude-dir=env "\s$" * | |||
| RET=$(($RET + $?)) ; echo $MSG "DONE" | |||
| unset INVGREP_APPEND | |||
|
|
|||
| MSG = 'Check files that in pandas/doc/source that use standardized documentation' ; echo $MSG | |||
| for entry in $(find ../doc/source/ -type f) | |||
There was a problem hiding this comment.
I think instead of the for we can use the invgrep pattern like the check above this.
|
@willie3838 can you address comments #33592 (comment) and #33592 (comment) |
|
@willie3838 can you merge master and address comments |
|
closing as stale |
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffI created a check to see which files contain Pandas or pandas which will be of use for individuals aiming to resolve issue #32316. When the codecheck script is run, it will output the files that contain those strings.