Skip to content

[AIRFLOW-1997] Fix doc strings of GCP operators#2939

Closed
kaxil wants to merge 1 commit intoapache:masterfrom
kaxil:docstring_fix
Closed

[AIRFLOW-1997] Fix doc strings of GCP operators#2939
kaxil wants to merge 1 commit intoapache:masterfrom
kaxil:docstring_fix

Conversation

@kaxil
Copy link
Member

@kaxil kaxil commented Jan 12, 2018

Make sure you have checked all steps below.

JIRA

Description

  • Here are some details about my PR, including screenshots of any UI changes:
    Fixed doc strings from DataProc and GCS Operators so that would aid in automatic documentation generation.

Tests

  • My PR adds the following unit tests OR does not need testing for this extremely good reason:
    It just changes the docstrings. Hence no tests required.

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
    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"
  • Passes git diff upstream/master -u -- "*.py" | flake8 --diff

- Fixed doc strings from DataProc and GCS Operators so that would aid in automatic documentation generation.

- Fixed Flake8 warnings
@codecov-io
Copy link

Codecov Report

Merging #2939 into master will decrease coverage by 0.06%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2939      +/-   ##
==========================================
- Coverage   73.54%   73.47%   -0.07%     
==========================================
  Files         160      160              
  Lines       12208    12208              
==========================================
- Hits         8978     8970       -8     
- Misses       3230     3238       +8
Impacted Files Coverage Δ
airflow/task/task_runner/bash_task_runner.py 93.33% <0%> (-6.67%) ⬇️
airflow/utils/helpers.py 53.44% <0%> (-2.88%) ⬇️
airflow/jobs.py 79.48% <0%> (-0.27%) ⬇️
airflow/models.py 87% <0%> (+0.04%) ⬆️

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 eb994d6...f6f0fa0. Read the comment docs.

@criccomini
Copy link
Contributor

LGTM

@asfgit asfgit closed this in b48bbbd Jan 12, 2018
Acehaidrey pushed a commit to Acehaidrey/incubator-airflow that referenced this pull request Jan 19, 2018
@kaxil kaxil deleted the docstring_fix branch February 4, 2018 01:12
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