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 2020/10/12 04:22:30 UTC

[GitHub] [airflow] mrwacky42 opened a new pull request #11452: Enable Pydocstyle D200 check

mrwacky42 opened a new pull request #11452:
URL: https://github.com/apache/airflow/pull/11452


   Judicious use of Perl:
   
   ```
   pre-commit run -a pydocstyle 2>&1 |grep module.level |cut -d: -f 1 |xargs perl -pi -e 'undef $/; s@"""\n(.*?)\n"""@"""\1"""@ms'
   pre-commit run -a pydocstyle 2>&1 |grep ^airflow |cut -d: -f 1| xargs perl -pi -e 'undef $/; s@"""\n +([^\n]+)\n +"""@"""\1"""@gms'
   pre-commit run -a pydocstyle 2>&1 |grep ^airflow |cut -d: -f 1| xargs perl -pi -e 'undef $/; s@"""\n +([^\n]+)\n+ +"""@"""\1"""@gms'
   ```
   
   Then fix a few things manually here and there.
   
   <!--
   Thank you for contributing! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of existing issue, reference it using one of the following:
   
   related: #10742
   
   How to write a good git commit message:
   http://chris.beams.io/posts/git-commit/
   -->
   
   ---
   
   
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
   In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
   


----------------------------------------------------------------
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 #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-706850033


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

[GitHub] [airflow] mrwacky42 commented on pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
mrwacky42 commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-707996685


   @mik-laj - Let me know if I can help here..


----------------------------------------------------------------
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] mik-laj commented on pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
mik-laj commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-707365766


   There was a conflict merge. I tried to solve this problem using Web UI. Hope it works.


----------------------------------------------------------------
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 #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-708532401


   [The Workflow run](https://github.com/apache/airflow/actions/runs/306872724) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks$,^Build docs$,^Spell check docs$,^Backport packages$,^Checks: Helm tests$,^Test OpenAPI*.


----------------------------------------------------------------
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] stale[bot] commented on pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
stale[bot] commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-751239968


   This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
   


----------------------------------------------------------------
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 #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-707984362


   [The Workflow run](https://github.com/apache/airflow/actions/runs/305121867) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks$,^Build docs$,^Spell check docs$,^Backport packages$,^Checks: Helm tests$,^Test OpenAPI*.


----------------------------------------------------------------
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] closed pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed pull request #11452:
URL: https://github.com/apache/airflow/pull/11452


   


----------------------------------------------------------------
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] mrwacky42 commented on pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
mrwacky42 commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-707234466


   Not sure how that happened, it passed locally. I'll fix it up.


----------------------------------------------------------------
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] mik-laj commented on pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
mik-laj commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-708347805


   Something is broken after rebase. Can you look at it?


----------------------------------------------------------------
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] kaxil commented on pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
kaxil commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-721446061


   Can you please rebase your PR on latest Master since we have applied [Black](https://github.com/apache/airflow/commit/4e8f9cc8d02b29c325b8a5a76b4837671bdf5f68) and [PyUpgrade](https://github.com/apache/airflow/commit/8c42cf1b00c90f0d7f11b8a3a455381de8e003c5) on Master.
   
   It will help if your squash your commits into single commit first so that there are less conflicts.
   


----------------------------------------------------------------
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] mik-laj commented on pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
mik-laj commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-707948691


   I am working on a rebase for this change.


----------------------------------------------------------------
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] mik-laj commented on pull request #11452: Enable Pydocstyle D200 check

Posted by GitBox <gi...@apache.org>.
mik-laj commented on pull request #11452:
URL: https://github.com/apache/airflow/pull/11452#issuecomment-706982638


   Some static checks are sad. Can you fix it?
   ```
   Run pydocstyle....................................................................................................................Failed
   - hook id: pydocstyle
   - exit code: 1
   
   docs/build_docs.py:42 in public class `DocBuildError`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:68 in public class `SpellingError`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:110 in public function `clean_files`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:121 in public function `display_errors_summary`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:139 in public function `display_spelling_error_summary`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:194 in private nested class `ClassVisitor`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:217 in public function `check_guide_links_in_operator_descriptions`:
           D200: One-line docstring should fit on one line with quotes (found 4)
   docs/build_docs.py:330 in public function `check_class_links_in_operators_and_hooks_ref`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:364 in public function `check_guide_links_in_operators_and_hooks_ref`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:409 in public function `check_exampleinclude_for_example_dags`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:426 in public function `check_enforce_code_block`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/build_docs.py:460 in public function `check_google_guides`:
           D200: One-line docstring should fit on one line with quotes (found 4)
   docs/build_docs.py:680 in public function `build_sphinx_docs`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/exts/sphinx_script_update.py:38 in private function `_user_cache_dir`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   airflow/contrib/hooks/gcp_transfer_hook.py:18 at module level:
           D209: Multi-line docstring closing quotes should be on a separate line
   metastore_browser/hive_metastore.py:49 in public class `MetastoreBrowserView`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   metastore_browser/hive_metastore.py:57 in public method `index`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   metastore_browser/hive_metastore.py:83 in public method `table`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   metastore_browser/hive_metastore.py:95 in public method `db`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   metastore_browser/hive_metastore.py:107 in public method `partitions`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   metastore_browser/hive_metastore.py:138 in public method `objects`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   metastore_browser/hive_metastore.py:169 in public method `data`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   metastore_browser/hive_metastore.py:183 in public method `ddl`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   metastore_browser/hive_metastore.py:201 in public class `MetastoreBrowserPlugin`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   docs/exts/exampleinclude.py:45 in public class `ExampleHeader`:
           D200: One-line docstring should fit on one line with quotes (found 3)
   ```


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