Skip to content

CI: Using docstring validator from numpydoc #30746

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.

Sign up for GitHub

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

Merged
merged 17 commits into from
Jan 16, 2020
Merged

CI: Using docstring validator from numpydoc #30746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e83308f
Working on using the numpydoc validation
datapythonista Nov 8, 2019
d9407f0
Adding documentation to pandas_validation function
datapythonista Nov 21, 2019
1ea7e46
Merging from master
datapythonista Nov 21, 2019
4a6af1f
Merge remote-tracking branch 'upstream/master' into numpydoc_validation
datapythonista Dec 1, 2019
23c6ba2
Working on the validation script, and deps updated
datapythonista Dec 1, 2019
0d4f570
Merge from master
datapythonista Jan 6, 2020
5fde770
Finishing the changes, first version working
datapythonista Jan 6, 2020
6a9c229
Linting
datapythonista Jan 6, 2020
8da9632
Merging from master
datapythonista Jan 7, 2020
22fff6f
Using format for GitHub actions, and not azure
datapythonista Jan 7, 2020
2594df5
Fixing tests
datapythonista Jan 7, 2020
ca66661
Removing error of missing see also section, since it wasn't actually …
datapythonista Jan 7, 2020
516fdeb
Installing numpydoc from conda
datapythonista Jan 7, 2020
6555e8c
Revert "Installing numpydoc from conda"
datapythonista Jan 7, 2020
413a27d
Restoring f-string, and fixing typos in argparse messages
datapythonista Jan 7, 2020
46a0648
Merge remote-tracking branch 'upstream/master' into numpydoc_validation
datapythonista Jan 7, 2020
12d5d52
Black
datapythonista Jan 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,8 +311,8 @@ fi
### DOCSTRINGS ###
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Validate docstrings (GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA01, SA02, SA03, SA05)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA01,SA02,SA03,SA05
MSG='Validate docstrings (GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03, SA05)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA02,SA03,SA05
RET=$(($RET + $?)) ; echo $MSG "DONE"

fi
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ dependencies:
# documentation
- gitpython # obtain contributors from git for whatsnew
- sphinx
- numpydoc>=0.9.0

# documentation (jupyter notebooks)
- nbconvert>=5.4.1
Expand Down Expand Up @@ -105,3 +104,4 @@ dependencies:
- tabulate>=0.8.3 # DataFrame.to_markdown
- pip:
- git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
- git+https://github.com/numpy/numpydoc
4 changes: 2 additions & 2 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ mypy==0.730
pycodestyle
gitpython
sphinx
numpydoc>=0.9.0
nbconvert>=5.4.1
nbsphinx
pandoc
Expand Down Expand Up @@ -70,4 +69,5 @@ sqlalchemy
xarray
pyreadstat
tabulate>=0.8.3
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
git+https://github.com/numpy/numpydoc
Loading