Enable flake8-rst-docstrings checks

eirikurj commented 1 year ago

Purpose

Noticed that many of our repos have a broken API documentation, see here for example. Enabling the flake8-rst-docstrings should address this.

Expected time until merged

Type of change

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (non-backwards-compatible fix or feature)
[x] Code style update (formatting, renaming)
[ ] Refactoring (no functional changes, no API changes)
[ ] Documentation update
[ ] Maintenance update
[ ] Other (please describe)

Testing

Checklist

[ ] I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
[ ] I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
[ ] I have run unit and regression tests which pass locally with my changes
[ ] I have added new tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation

eirikurj commented 1 year ago

Yeah, I think it would be a good initial step to writing better doc strings. We can disable check on some specific codes if there are issues we do not like or want to address in the future. As for pyGeo, I just did a quick check and from what I can tell, I dont think its too bad. I can push and make a PR there addressing these soon.

eirikurj commented 1 year ago

PR is up https://github.com/mdolab/pygeo/pull/190

mdolab / .github