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][1/3] Syntax docs improvements #4789

Merged
merged 1 commit into from
Feb 27, 2019

Conversation

mik-laj
Copy link
Member

@mik-laj mik-laj commented Feb 27, 2019

Make sure you have checked all steps below.

Jira

No applicable

Description

This is one of the PR series aimed to add automatically API Reference.

I would ask you to accept changes in order.

Documentation preview with all changes is available:
http://neighborly-sun.surge.sh/autoapi/index.html

There were various syntax errors in the documentation that prevented the correct build of new documentation.

CC: @ashb

Tests

No applicable

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

Co-authored-by: Jarek Potiuk <jarek.potiuk@polidea.com>
@mik-laj mik-laj force-pushed the autoapit-split-2-of-3 branch from 817c41c to 9ed86ef Compare February 27, 2019 10:11
@codecov-io
Copy link

Codecov Report

Merging #4789 into master will decrease coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4789      +/-   ##
==========================================
- Coverage   74.44%   74.44%   -0.01%     
==========================================
  Files         450      450              
  Lines       28970    28970              
==========================================
- Hits        21567    21566       -1     
- Misses       7403     7404       +1
Impacted Files Coverage Δ
airflow/contrib/hooks/gcp_vision_hook.py 82.85% <ø> (ø) ⬆️
...irflow/contrib/example_dags/example_gcp_spanner.py 0% <ø> (ø) ⬆️
airflow/lineage/__init__.py 96.61% <ø> (ø) ⬆️
.../contrib/operators/jenkins_job_trigger_operator.py 67.96% <ø> (ø) ⬆️
airflow/utils/dates.py 83.5% <ø> (ø) ⬆️
airflow/contrib/utils/gcp_field_validator.py 91.52% <ø> (ø) ⬆️
airflow/task/task_runner/base_task_runner.py 79.31% <ø> (ø) ⬆️
airflow/ti_deps/dep_context.py 100% <ø> (ø) ⬆️
airflow/models/__init__.py 92.59% <ø> (-0.06%) ⬇️
...rflow/contrib/example_dags/example_gcp_function.py 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 b0c4d37...9ed86ef. Read the comment docs.

Copy link
Member

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

Good changes. It is necessary prerequisite to make AutoAPI works.

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.

LGTM, thanks @mik-laj

@Fokko Fokko merged commit 0982715 into apache:master Feb 27, 2019
ashb pushed a commit to ashb/airflow that referenced this pull request Mar 27, 2019
Co-authored-by: Jarek Potiuk <jarek.potiuk@polidea.com>
andriisoldatenko pushed a commit to andriisoldatenko/airflow that referenced this pull request Jul 26, 2019
Co-authored-by: Jarek Potiuk <jarek.potiuk@polidea.com>
wmorris75 pushed a commit to modmed/incubator-airflow that referenced this pull request Jul 29, 2019
Co-authored-by: Jarek Potiuk <jarek.potiuk@polidea.com>
@potiuk potiuk deleted the autoapit-split-2-of-3 branch September 19, 2019 22:46
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.

4 participants