[
https://issues.apache.org/jira/browse/AIRFLOW-3174?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16648043#comment-16648043
]
ASF GitHub Bot commented on AIRFLOW-3174:
-----------------------------------------
XD-DENG opened a new pull request #4043: [AIRFLOW-3174] Refine Docstring for
SQL Operators & Hooks
URL: https://github.com/apache/incubator-airflow/pull/4043
### JIRA
https://issues.apache.org/jira/browse/AIRFLOW-3174
### Description
- [x] Here are some details about my PR, including screenshots of any UI
changes:
- These SQL operators (based on `DbApiHook`) receive `sql` and `parameters`
(optional) as arguments. But `parameters` were not documented. The contents I
added is based on the docstring in
https://github.com/apache/incubator-airflow/blob/master/airflow/hooks/dbapi_hook.py#L88
- Fixed two minor style errors which would cause incorrect documentation
rendering
- Added docstring for `autocommit` parameter in relevant operators. The
content is based on
https://db.apache.org/derby/docs/10.9/devguide/cdevconcepts29416.html and
https://www.postgresql.org/docs/9.1/static/ecpg-commands.html
- Adjusted order or docstring items to make sure they are consistent with
the order of arguments.
----------------------------------------------------------------
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:
[email protected]
> Refine Docstring for SQL Operators
> ----------------------------------
>
> Key: AIRFLOW-3174
> URL: https://issues.apache.org/jira/browse/AIRFLOW-3174
> Project: Apache Airflow
> Issue Type: Improvement
> Components: operators
> Reporter: Xiaodong DENG
> Assignee: Xiaodong DENG
> Priority: Minor
>
> SQL operators (based on {{DbApiHook}}) receive {{sql}} and {{parameters}}
> (optional) as arguments. But {{parameters}} were not documented.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
