You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/03/21 03:30:59 UTC

[GitHub] [airflow] jlaneve opened a new pull request #14918: Update docstrings to adhere to sphinx standards

jlaneve opened a new pull request #14918:
URL: https://github.com/apache/airflow/pull/14918


   Certain modules have mechanical mistakes in their docstrings according to [sphinx standards](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html). This PR fixes docstrings in 8 modules, namely:
   
   - YandexCloud
   - GoogleSheetsToGCSOperator
   - GoogleDisplayVideo360GetSDFDownloadOperationSensor
   - SalesforceToGcsOperator
   - GCSToLocalFilesystemOperator
   - FacebookAdsReportToGcsOperator
   - BigQueryToMySqlOperator
   - AzureFileShareToGCSOperator


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [airflow] ephraimbuddy merged pull request #14918: Update docstrings to adhere to sphinx standards

Posted by GitBox <gi...@apache.org>.

ephraimbuddy merged pull request #14918:
URL: https://github.com/apache/airflow/pull/14918


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [airflow] boring-cyborg[bot] commented on pull request #14918: Update docstrings to adhere to sphinx standards

Posted by GitBox <gi...@apache.org>.

boring-cyborg[bot] commented on pull request #14918:
URL: https://github.com/apache/airflow/pull/14918#issuecomment-803919280


   Awesome work, congrats on your first merged pull request!
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [airflow] ephraimbuddy commented on pull request #14918: Update docstrings to adhere to sphinx standards

Posted by GitBox <gi...@apache.org>.

ephraimbuddy commented on pull request #14918:
URL: https://github.com/apache/airflow/pull/14918#issuecomment-803921090


   Thanks @jlaneve!!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [airflow] github-actions[bot] commented on pull request #14918: Update docstrings to adhere to sphinx standards

Posted by GitBox <gi...@apache.org>.

github-actions[bot] commented on pull request #14918:
URL: https://github.com/apache/airflow/pull/14918#issuecomment-803554662


   The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest master or amend the last commit of the PR, and push it with --force-with-lease.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [airflow] turbaszek commented on pull request #14918: Update docstrings to adhere to sphinx standards

Posted by GitBox <gi...@apache.org>.

turbaszek commented on pull request #14918:
URL: https://github.com/apache/airflow/pull/14918#issuecomment-803554665


   @jlaneve thanks for the PR! Could you please take a look at the CI issues?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [airflow] jlaneve commented on pull request #14918: Update docstrings to adhere to sphinx standards

Posted by GitBox <gi...@apache.org>.

jlaneve commented on pull request #14918:
URL: https://github.com/apache/airflow/pull/14918#issuecomment-803650850


   @turbaszek thank you - I've fixed the CI issues!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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

[GitHub] [airflow] boring-cyborg[bot] commented on pull request #14918: Update docstrings to adhere to sphinx standards

Posted by GitBox <gi...@apache.org>.

boring-cyborg[bot] commented on pull request #14918:
URL: https://github.com/apache/airflow/pull/14918#issuecomment-803506031

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/master/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) for testing locally, it’s a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#coding-style-and-best-practices).
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack

--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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