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] Improve format in code-block directives #6242

Merged
merged 1 commit into from
Oct 3, 2019

Conversation

mik-laj
Copy link
Member

@mik-laj mik-laj commented Oct 2, 2019

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.

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.
    • 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

@codecov-io
Copy link

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6242      +/-   ##
==========================================
+ Coverage   80.06%   80.06%   +<.01%     
==========================================
  Files         610      610              
  Lines       35261    35261              
==========================================
+ Hits        28231    28232       +1     
+ Misses       7030     7029       -1
Impacted Files Coverage Δ
airflow/utils/dag_processing.py 56.89% <0%> (+0.17%) ⬆️

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 d719e1f...ae9e579. Read the comment docs.

Copy link
Member

@feluelle feluelle left a comment

Choose a reason for hiding this comment

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

Minor suggestion - but looks fine to me :)

@@ -28,7 +28,7 @@ can edit it to change any of the settings. You can also set options with environ
For example, the
metadata database connection string can either be set in ``airflow.cfg`` like this:

.. code-block:: bash
.. code-block:: ini
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
.. code-block:: ini
.. code-block:: cfg

works, too - according to http://pygments.org/docs/lexers/#pygments.lexers.configs.IniLexer

Copy link
Member Author

@mik-laj mik-laj Oct 3, 2019

Choose a reason for hiding this comment

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

In other place, we use ini. I prefer not to introduce many ways to mark the same. https://raw.githubusercontent.com/apache/airflow/dd9071bf5e127d449eee304736d2a5125813f607/docs/usage-cli.rst
This is only information about the file format and pygments select this format by calling this class "Ini*". The information that cfg is also supported is not obvious.
WDYT?

Copy link
Member

Choose a reason for hiding this comment

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

👍

@mik-laj mik-laj merged commit 6c13adb into apache:master Oct 3, 2019
ashb pushed a commit to ashb/airflow that referenced this pull request Oct 10, 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