[AIRFLOW-3174] Refine Docstring for SQL Operators & Hooks #4043
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @Fokko , I accidentally screwed my branch and could not push to my earlier PR #4023 . So I had to open this new PR..... The comments you raised earlier (adjust order for consistency, add docstring for I also addressed two minor style errors in two Hook files. Thanks. |
|
BTW, given it's only docstring change, I had I had already run Flake8 check locally to make sure no Flake8 error. |
|
Thanks @Fokko for merging :-) |
aliceabe
pushed a commit
to aliceabe/incubator-airflow
that referenced
this pull request
Jan 3, 2019
Add missing arguments
ashb
pushed a commit
to ashb/airflow
that referenced
this pull request
Mar 8, 2019
Add missing arguments
wmorris75
pushed a commit
to modmed/incubator-airflow
that referenced
this pull request
Jul 29, 2019
Add missing arguments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
JIRA
https://issues.apache.org/jira/browse/AIRFLOW-3174
Description
Here are some details about my PR, including screenshots of any UI changes:
These SQL operators (based on
DbApiHook) receivesqlandparameters(optional) as arguments. Butparameterswere 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#L88Fixed two minor style errors which would cause incorrect documentation rendering
Added docstring for
autocommitparameter 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.htmlAdjusted order or docstring items to make sure they are consistent with the order of arguments.