[GitHub] kaxil edited a comment on issue #4137: [AIRFLOW-XXX] Fix Docstrings in Hooks, Sensors & Operators

[GitBox <gi...@apache.org>]

kaxil edited a comment on issue #4137: [AIRFLOW-XXX] Fix Docstrings in Hooks, Sensors & Operators
URL: https://github.com/apache/incubator-airflow/pull/4137#issuecomment-436084787
 
 
   @Fokko @ashb @r39132    I found https://pypi.org/project/flake8-docstrings/ which we can include it in `.github/PULL_REQUEST_TEMPLATE.md` to enforce that docstrings are included and also in correct format. 
   
   A user should then do the following:
   
   ```
   git diff upstream/master -u -- "*.py" | flake8 --diff 
   ```
   
   We only need to add `flake8-docstrings` as dependency.
   
   However, we might want to ignore many rules which we might need to either try it ourselves or find some docs/list and decide.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services