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-XXX] Add missing docs for SNS classes #4155

Merged
merged 1 commit into from
Nov 11, 2018

Conversation

sjednac
Copy link
Contributor

@sjednac sjednac commented Nov 7, 2018

Jira

  • My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"

Description

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

Addresses the missing documentation concern raised by @ashb in #4123.

Tests

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

Just a doc 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"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.

Code Quality

  • Passes flake8

Provide autoclass docs for new SNS classes in `docs/code.rst`, as
it was missed in the initial pull request.
@sjednac sjednac force-pushed the sns-autoclass-docs branch from be7bc8c to 8c44dad Compare November 8, 2018 21:10
@codecov-io
Copy link

codecov-io commented Nov 8, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4155   +/-   ##
=======================================
  Coverage   77.66%   77.66%           
=======================================
  Files         199      199           
  Lines       16273    16273           
=======================================
  Hits        12638    12638           
  Misses       3635     3635

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 9248e37...8c44dad. Read the comment docs.

@kaxil kaxil merged commit 4462021 into apache:master Nov 11, 2018
@kaxil
Copy link
Member

kaxil commented Nov 11, 2018

Thanks @sbilinski

galak75 pushed a commit to VilledeMontreal/incubator-airflow that referenced this pull request Nov 23, 2018
tmiller-msft pushed a commit to cse-airflow/incubator-airflow that referenced this pull request Nov 27, 2018
elizabethhalper pushed a commit to cse-airflow/incubator-airflow that referenced this pull request Dec 7, 2018
aliceabe pushed a commit to aliceabe/incubator-airflow that referenced this pull request Jan 3, 2019
cfei18 pushed a commit to cfei18/incubator-airflow that referenced this pull request Jan 23, 2019
wmorris75 pushed a commit to modmed/incubator-airflow that referenced this pull request Jul 29, 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.

3 participants