Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AIRFLOW-5497] Update docstring with param description #6314

Merged
merged 3 commits into from
Oct 14, 2019

Conversation

chicochico
Copy link
Contributor

Make sure you have checked all steps below.

Jira

  • My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"
    • https://issues.apache.org/jira/browse/AIRFLOW-XXX
    • In case you are fixing a typo in the documentation you can prepend your commit with [AIRFLOW-XXX], code changes always need a Jira issue.
    • In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal (AIP).
    • In case you are adding a dependency, check if the license complies with the ASF 3rd Party License Policy.

Tests

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

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 (not including Jira issue reference)
    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"

Copy link
Contributor

@BasPH BasPH left a comment

Choose a reason for hiding this comment

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

Looks good. Tests seem flaky so I restarted the failed tests.

@codecov-io
Copy link

codecov-io commented Oct 12, 2019

Codecov Report

Merging #6314 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6314      +/-   ##
==========================================
- Coverage   80.34%   80.34%   -0.01%     
==========================================
  Files         616      616              
  Lines       35733    35737       +4     
==========================================
+ Hits        28711    28712       +1     
- Misses       7022     7025       +3
Impacted Files Coverage Δ
airflow/utils/dag_processing.py 56.37% <ø> (-0.52%) ⬇️
airflow/gcp/operators/bigquery.py 86.44% <0%> (-0.17%) ⬇️
airflow/gcp/operators/mlengine.py 89.51% <0%> (ø) ⬆️
airflow/config_templates/airflow_local_settings.py 80.48% <0%> (+0.48%) ⬆️
airflow/gcp/hooks/mlengine.py 83.73% <0%> (+1.04%) ⬆️
airflow/operators/redshift_to_s3_operator.py 97.14% <0%> (+1.58%) ⬆️

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 c0d98a7...c778f91. Read the comment docs.

Add param type to docstring

Co-Authored-By: Felix Uellendall <[email protected]>
airflow/utils/dag_processing.py Outdated Show resolved Hide resolved
Fix docstring formatting

Co-Authored-By: Ash Berlin-Taylor <[email protected]>
@ashb ashb merged commit bb93a75 into apache:master Oct 14, 2019
ashb pushed a commit that referenced this pull request Oct 16, 2019
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.

5 participants