[AIRFLOW-2205] Remove unsupported args from JdbcHook doc#3121
Merged
asfgit merged 1 commit intoapache:masterfrom Mar 13, 2018
Merged
[AIRFLOW-2205] Remove unsupported args from JdbcHook doc#3121asfgit merged 1 commit intoapache:masterfrom
asfgit merged 1 commit intoapache:masterfrom
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3121 +/- ##
=======================================
Coverage 73.04% 73.04%
=======================================
Files 180 180
Lines 12596 12596
=======================================
Hits 9201 9201
Misses 3395 3395
Continue to review full report at Codecov.
|
jgao54
reviewed
Mar 12, 2018
airflow/hooks/jdbc_hook.py
Outdated
Contributor
Author
There was a problem hiding this comment.
Thanks for the review @jgao54! As you know, DbApiHook and its subclasses take a parameter which name is defined by conn_name_attr class variable, so I added it to the docstring. But I've just noticed that other hooks derived from DbApiHook (such as MsSql, MySql, Postgres) don't mention that in their docstring, so I'll remove those lines for consistency with them.
JdbcHook's docstring has unsupported arguments and unimplemented feature description. This PR fixes them and adds JdbcHook to the API reference.
This file contains hidden or 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
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.
Make sure you have checked all steps below.
JIRA
Description
JdbcHook's docstring has unsupported arguments,
a wrongly named argument and unimplemented feature description.
This PR fixes them and adds JdbcHook to the API reference.
Tests
This PR doesn't need testing since it's documentation fix. I ran docs/build.sh locally and confirmed that the API document was generated as expected.
Commits
My commits all reference JIRA issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message":
Passes
git diff upstream/master -u -- "*.py" | flake8 --diff