You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "josh-fell (via GitHub)" <gi...@apache.org> on 2023/03/02 05:10:48 UTC
[GitHub] [airflow] josh-fell opened a new pull request, #29863: Fix Python API docs formatting for Common SQL provider
josh-fell opened a new pull request, #29863:
URL: https://github.com/apache/airflow/pull/29863
There were a number of places in which poor or incorrect formatting led to illegible documentation or funky appearances.
*Hooks*
| Before | After |
| ------- | ------ |
|<img width="874" alt="image" src="https://user-images.githubusercontent.com/48934154/222335760-6764e6d8-0887-476b-b550-b3ced06f0912.png"> | <img width="893" alt="image" src="https://user-images.githubusercontent.com/48934154/222335811-08b2ec98-61e9-41fd-9a95-a346f2b155c4.png"> |
*Operators*
| Before | After |
| ------- | ------ |
|<img width="920" alt="image" src="https://user-images.githubusercontent.com/48934154/222336054-b23caa3b-5970-480e-945c-ab46f9d201e5.png">| <img width="908" alt="image" src="https://user-images.githubusercontent.com/48934154/222336110-0aee92f7-8992-4938-b9bf-c6a695b2bbe3.png"> |
|<img width="920" alt="image" src="https://user-images.githubusercontent.com/48934154/222336274-bef28852-3676-4d62-a3f4-a4e094348a5a.png"> | <img width="906" alt="image" src="https://user-images.githubusercontent.com/48934154/222336334-e3440a40-41a1-4e98-9f26-8ccbd4133168.png"> |
| <img width="901" alt="image" src="https://user-images.githubusercontent.com/48934154/222336442-364da4d5-b752-4bad-91a8-3cb257f06fec.png"> | <img width="886" alt="image" src="https://user-images.githubusercontent.com/48934154/222336511-3a7d298b-cff4-46cd-89c1-715e4e83e65c.png"> |
| <img width="915" alt="image" src="https://user-images.githubusercontent.com/48934154/222336662-f966dfea-0e87-4952-8ed1-c6b0d6f0b7aa.png"> | <img width="913" alt="image" src="https://user-images.githubusercontent.com/48934154/222336725-8913791f-5ff5-4390-88fa-7ce73534c77a.png"> |
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] josh-fell commented on a diff in pull request #29863: Fix Python API docs formatting for Common SQL provider
Posted by "josh-fell (via GitHub)" <gi...@apache.org>.
josh-fell commented on code in PR #29863:
URL: https://github.com/apache/airflow/pull/29863#discussion_r1122605503
##########
airflow/providers/common/sql/operators/sql.py:
##########
@@ -73,6 +73,8 @@ def _get_failed_checks(checks, col=None):
parse_boolean = _parse_boolean
"""
+:sphinx-autoapi-skip:
Review Comment:
Seemed like this is only pertinent for internal/maintainer use and shouldn't _really_ be in external Python API documentation.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] josh-fell merged pull request #29863: Fix Python API docs formatting for Common SQL provider
Posted by "josh-fell (via GitHub)" <gi...@apache.org>.
josh-fell merged PR #29863:
URL: https://github.com/apache/airflow/pull/29863
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] josh-fell commented on a diff in pull request #29863: Fix Python API docs formatting for Common SQL provider
Posted by "josh-fell (via GitHub)" <gi...@apache.org>.
josh-fell commented on code in PR #29863:
URL: https://github.com/apache/airflow/pull/29863#discussion_r1122605503
##########
airflow/providers/common/sql/operators/sql.py:
##########
@@ -73,6 +73,8 @@ def _get_failed_checks(checks, col=None):
parse_boolean = _parse_boolean
"""
+:sphinx-autoapi-skip:
Review Comment:
Seemed like this is only pertinent for internal/maintainer use and shouldn't really be part of external-facing Python API documentation.
##########
airflow/providers/common/sql/operators/sql.py:
##########
@@ -73,6 +73,8 @@ def _get_failed_checks(checks, col=None):
parse_boolean = _parse_boolean
"""
+:sphinx-autoapi-skip:
Review Comment:
Seemed like this is only pertinent for internal/maintainer use and shouldn't really be part of user-facing Python API documentation.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org