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-6270) Remove "good" errors/"warnings" from docs_build
Date Wed, 18 Dec 2019 22:00:00 GMT

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

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

mik-laj commented on pull request #6845: [AIRFLOW-6270] Remove "good" errors from docs building
URL: https://github.com/apache/airflow/pull/6845
 
 
   When docs are build, errrors/warnigs are printed which might be confusing to
   the user. The three lines:
   
   None:3: (ERROR/3) Unexpected indentation.
   None:9: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
   None:10: (WARNING/2) Block quote ends without a blank line; unexpected unindent.
   
   They are always printed but they are always ignored because they does not affect CI.
   
   ---
   
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/)
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](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd
Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### 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](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
   
   - [ ] 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](https://github.com/apache/airflow/blob/master/UPDATING.md)
so we can assign it to a appropriate release
   
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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


> Remove "good" errors/"warnings" from docs_build
> -----------------------------------------------
>
>                 Key: AIRFLOW-6270
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-6270
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: ci
>    Affects Versions: 2.0.0
>            Reporter: Jarek Potiuk
>            Priority: Major
>
> When docs are build, errrors/warnigs are printed which might be confusing to the user.
The three lines:
> {code:java}
> None:3: (ERROR/3) Unexpected indentation.
> None:9: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
> None:10: (WARNING/2) Block quote ends without a blank line; unexpected unindent.{code}
> Are always printed but they are not real errors - as an effect people think that those
are real errors that they have to fix (but they do not know how).



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Mime
View raw message