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-3202] add missing documentation for AWS hooks/operator #4048

Merged
merged 2 commits into from
Oct 13, 2018

Conversation

sid88in
Copy link
Contributor

@sid88in sid88in commented Oct 13, 2018

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"

Description

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

Tests

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

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

@sid88in
Copy link
Contributor Author

sid88in commented Oct 13, 2018

Sometime back I added AWS hooks/operators but don't see them in the documentation, so adding them now :)

@@ -313,6 +313,49 @@ S3ToRedshiftTransfer

.. autoclass:: airflow.operators.s3_to_redshift_operator.S3ToRedshiftTransfer

AWS DynamoDB
''''''''
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you align the '''':

AWS DynamoDB
''''''''''''

Otherwise this will generate warnings at compile time. Thanks.

Copy link
Contributor

@Fokko Fokko left a comment

Choose a reason for hiding this comment

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

Thanks @sid88in LGTM.

@Fokko Fokko merged commit b862ca8 into apache:master Oct 13, 2018
@sid88in
Copy link
Contributor Author

sid88in commented Oct 13, 2018

thanks @Fokko !!

aliceabe pushed a commit to aliceabe/incubator-airflow that referenced this pull request Jan 3, 2019
ashb pushed a commit that referenced this pull request Mar 26, 2019
Add missing documentation for AWS hooks/operator
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.

2 participants