[GitHub] kaxil commented on a change in pull request #4282: [AIRFLOW-XXX] Add Docstrings as Requirement in Contribution template
kaxil 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_r239216387 ## 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: Done, updated. https://pep8.org/#descriptive-naming-styles >The underscore prefix is meant as a hint to another programmer that a variable or method starting with a single underscore is intended for internal use. 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: us...@infra.apache.org With regards, Apache Git Services
[GitHub] kaxil commented on a change in pull request #4282: [AIRFLOW-XXX] Add Docstrings as Requirement in Contribution template
kaxil 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_r239216387 ## 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: Done, updated. https://pep8.org/#descriptive-naming-styles >_single_leading_underscore: weak “internal use” indicator. E.g. from M import * does not import objects whose name starts with an underscore. 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: us...@infra.apache.org With regards, Apache Git Services
[GitHub] kaxil commented on a change in pull request #4282: [AIRFLOW-XXX] Add Docstrings as Requirement in Contribution template
kaxil 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_r239216387 ## 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: Sure I agree, will update that. 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: us...@infra.apache.org With regards, Apache Git Services
