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-6331) Pylint: Disable Missing Module Docstring
Date Mon, 23 Dec 2019 18:18:00 GMT

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

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

kaxil commented on pull request #6885: [AIRFLOW-6331] Pylint: Disable Missing Module Docstring
URL: https://github.com/apache/airflow/pull/6885
 
 
   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. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-6331
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   With pylint 2.4 and above you can differentiate between the various missing-docstring by
using the three following sub-messages:
   
   ```
   C0114 (missing-module-docstring)
   C0115 (missing-class-docstring)
   C0116 (missing-function-docstring)
   ```
   
   Docstrings that start "This is module foobar." It is already self-evident what this module
is. Restating it is redundant and prone to going out of date if the module ever changes name.
   
   ### 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.
     - 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


> Pylint: Disable Missing Module Docstring
> ----------------------------------------
>
>                 Key: AIRFLOW-6331
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-6331
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 2.0.0
>            Reporter: Kaxil Naik
>            Assignee: Kaxil Naik
>            Priority: Minor
>             Fix For: 2.0.0
>
>
> We should upgrade Pylint to 2.4.4 and remove the need of added docstring ats Module Level
> - https://github.com/PyCQA/pylint/issues/1164
> - https://github.com/PyCQA/pylint/blob/master/ChangeLog#L1371
> - https://stackoverflow.com/a/7878690/5691525



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

Mime
View raw message