Skip to content

[AIRFLOW-XXXX] Include code tags for sample file names#6360

Merged
mik-laj merged 1 commit intoapache:masterfrom
frankcash:patch-1
Oct 17, 2019
Merged

[AIRFLOW-XXXX] Include code tags for sample file names#6360
mik-laj merged 1 commit intoapache:masterfrom
frankcash:patch-1

Conversation

@frankcash
Copy link
Contributor

Improves readability of docs

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.

AIRFLOW-XXX path as this a doc change

Description

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

Changes quotes around files to code formatting for visual indication that we are discussing a file.

Proposed changes:
Screen Shot 2019-10-17 at 11 40 47 AM

Tests

  • My PR adds the following unit tests OR does not need testing for this extremely good reason: simple RST 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.
    • All the public functions and the classes in the PR contain docstrings that explain what it does
    • If you implement backwards incompatible changes, please leave a note in the Updating.md so we can assign it to a appropriate release

@mik-laj mik-laj merged commit dde65a6 into apache:master Oct 17, 2019
@frankcash
Copy link
Contributor Author

Thank you 😄

@frankcash frankcash deleted the patch-1 branch October 18, 2019 02:53
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