[GitHub] feng-tao commented on a change in pull request #4282: [AIRFLOW-XXX] Add Docstrings as Requirement in Contribution template

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

feng-tao commented on a change in pull request #4282: [AIRFLOW-XXX] Add Docstrings as Requirement in Contribution template
URL: https://github.com/apache/incubator-airflow/pull/4282#discussion_r239212369
 
 

 ##########
 File path: .github/PULL_REQUEST_TEMPLATE.md
 ##########
 @@ -28,6 +28,7 @@ Make sure you have checked _all_ steps below.
 
 - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
   - When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.
+  - All the functions and the classes in the PR contain docstrings that explain what it does
 
 Review comment:
   I know python doesn't have public/private func. But sometimes we use underscore in the beginning of the func to indicate it is a public func. Not sure if it is a convention else where. But we could call `All the public functions ...` 

----------------------------------------------------------------
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