airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (AIRFLOW-3018) Fix Documentation
Date Thu, 06 Sep 2018 02:02:00 GMT

    [ https://issues.apache.org/jira/browse/AIRFLOW-3018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16605167#comment-16605167
] 

ASF GitHub Bot commented on AIRFLOW-3018:
-----------------------------------------

kaxil opened a new pull request #3852: [AIRFLOW-3018] Fix Minor issues in Documentation
URL: https://github.com/apache/incubator-airflow/pull/3852
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/)
issues and references them in the PR title. 
     - https://issues.apache.org/jira/browse/AIRFLOW-3018
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   Documentation contains lots of hooks and operators with mis-spelled, missing types and
wrongly formatted text
   
   Few issues:
   <img width="691" alt="screen shot 2018-09-05 at 22 14 19" src="https://user-images.githubusercontent.com/8811558/45124817-b4eb5380-b163-11e8-9b85-5351f6732205.png">
   <img width="718" alt="screen shot 2018-09-05 at 22 51 49" src="https://user-images.githubusercontent.com/8811558/45124819-b4eb5380-b163-11e8-97a2-ddd38191678d.png">
   
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely
good reason:
   
   ### Commits
   
   - [x] 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](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] 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.
   
   ### Code Quality
   
   - [x] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Fix Documentation
> -----------------
>
>                 Key: AIRFLOW-3018
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-3018
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: docs, Documentation
>            Reporter: Kaxil Naik
>            Assignee: Kaxil Naik
>            Priority: Minor
>
> Documentation contains lots of hooks and operators with mis-spelled, missing types and
wrongly formatted text



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message