Skip to content

[AIRFLOW-2205] Remove unsupported args from JdbcHook doc#3121

Merged
asfgit merged 1 commit intoapache:masterfrom
sekikn:AIRFLOW-2205
Mar 13, 2018
Merged

[AIRFLOW-2205] Remove unsupported args from JdbcHook doc#3121
asfgit merged 1 commit intoapache:masterfrom
sekikn:AIRFLOW-2205

Conversation

@sekikn
Copy link
Contributor

@sekikn sekikn commented Mar 12, 2018

Make sure you have checked all steps below.

JIRA

Description

  • Here are some details about my PR, including screenshots of any UI changes:

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

  • My PR adds the following unit tests OR does not need testing for this extremely good reason:

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

    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"
  • Passes git diff upstream/master -u -- "*.py" | flake8 --diff

@codecov-io
Copy link

codecov-io commented Mar 12, 2018

Codecov Report

Merging #3121 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3121   +/-   ##
=======================================
  Coverage   73.04%   73.04%           
=======================================
  Files         180      180           
  Lines       12596    12596           
=======================================
  Hits         9201     9201           
  Misses       3395     3395
Impacted Files Coverage Δ
airflow/hooks/jdbc_hook.py 94.44% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 79e7c90...81f8aba. Read the comment docs.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be removed too right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

JdbcHook's docstring has unsupported arguments
and unimplemented feature description.
This PR fixes them and adds JdbcHook to the API reference.
@asfgit asfgit merged commit 81f8aba into apache:master Mar 13, 2018
asfgit pushed a commit that referenced this pull request Mar 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants