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-3995][WIP] Extract code from docs #77

Closed
wants to merge 3 commits into from
Closed

Conversation

mik-laj
Copy link
Member

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

Make sure you have checked all steps below.

Jira

Description

I extracted fragments of codes to separate files. This allows us to test them automatically. Some examples were incorrect, so I fixed them.

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.
    • All the public functions and the classes in the PR contain docstrings that explain what it does

Code Quality

  • Passes flake8

@mik-laj mik-laj changed the title [AIRFLOW-3995] Extract code from docs [AIRFLOW-3995][WIP] Extract code from docs Mar 2, 2019
Copy link

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

@mik-laj -> you are my documentation hero ;)

Love the change.

airflow/example_dags/example_bash_operator.py Outdated Show resolved Hide resolved
docs/concepts.rst Show resolved Hide resolved
docs/lineage.rst Show resolved Hide resolved
tests/plugins/test_plugin.py Outdated Show resolved Hide resolved
tests/test_documentation.py Outdated Show resolved Hide resolved
tests/www/test_utils.py Outdated Show resolved Hide resolved
tests/www/test_utils.py Outdated Show resolved Hide resolved
@mik-laj mik-laj force-pushed the extract-examples branch from 9165c0f to c2e6969 Compare June 6, 2019 11:17
@codecov-io
Copy link

codecov-io commented Jun 6, 2019

Codecov Report

❗ No coverage uploaded for pull request base (master@68e8c99). Click here to learn what that means.
The diff coverage is 0%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master      #77   +/-   ##
=========================================
  Coverage          ?   10.74%           
=========================================
  Files             ?      484           
  Lines             ?    30234           
  Branches          ?        0           
=========================================
  Hits              ?     3250           
  Misses            ?    26984           
  Partials          ?        0
Impacted Files Coverage Δ
airflow/example_dags/tutorial.py 0% <ø> (ø)
...ample_dags/example_branch_python_dop_operator_3.py 0% <ø> (ø)
...w/example_dags/example_latest_only_with_trigger.py 0% <ø> (ø)
...low/example_dags/example_trigger_controller_dag.py 0% <ø> (ø)
airflow/plugins_manager.py 85.84% <ø> (ø)
airflow/example_dags/example_latest_only.py 0% <ø> (ø)
airflow/example_dags/example_lineage.py 0% <0%> (ø)
airflow/example_dags/example_default_args.py 0% <0%> (ø)
airflow/example_dags/example_documentation.py 0% <0%> (ø)
airflow/example_dags/example_bash_operator.py 0% <0%> (ø)
... and 4 more

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 68e8c99...d0336a7. Read the comment docs.

@mik-laj mik-laj force-pushed the extract-examples branch from 22c6f53 to d0336a7 Compare June 6, 2019 15:05
@mik-laj mik-laj closed this Oct 11, 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