[
https://issues.apache.org/jira/browse/AIRFLOW-4364?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17028465#comment-17028465
]
ASF GitHub Bot commented on AIRFLOW-4364:
-----------------------------------------
BasPH commented on pull request #7336: [AIRFLOW-4364] Make all code in
airflow/providers/amazon pylint compatible
URL: https://github.com/apache/airflow/pull/7336
This PR makes all code in airflow/providers/amazon compatible with Pylint.
Mostly adding docstrings here and there.
---
Issue link: WILL BE INSERTED BY
[boring-cyborg](https://github.com/kaxil/boring-cyborg)
Make sure to mark the boxes below before creating PR: [x]
- [x] Description above provides context of the change
- [x] Commit message/PR title starts with `[AIRFLOW-NNNN]`. AIRFLOW-NNNN =
JIRA ID<sup>*</sup>
- [x] Unit tests coverage for changes (not needed for documentation changes)
- [x] Commits follow "[How to write a good git commit
message](http://chris.beams.io/posts/git-commit/)"
- [x] Relevant documentation is updated including usage instructions.
- [x] I will engage committers as explained in [Contribution Workflow
Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
<sup>*</sup> For document-only changes commit message can start with
`[AIRFLOW-XXXX]`.
---
In case of fundamental code change, Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in
[UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
Read the [Pull Request
Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)
for more information.
----------------------------------------------------------------
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:
[email protected]
> Integrate Pylint
> ----------------
>
> Key: AIRFLOW-4364
> URL: https://issues.apache.org/jira/browse/AIRFLOW-4364
> Project: Apache Airflow
> Issue Type: Improvement
> Components: pylint
> Affects Versions: 2.0.0
> Reporter: Bas Harenslak
> Priority: Major
>
> After a [vote on the mailing
> list|https://lists.apache.org/thread.html/f4940d36e98ded96a2473bb2ccdfa4cc648faa2c1334b2aa901c0bba@%3Cdev.airflow.apache.org%3E]
> everybody voted for pylint integration.
> Making the whole project Pylint compatible is a lot of work and big change.
> Therefore we split up all the work in subissues under this issue. The
> approach is as follows:
> All files are currently blacklisted from Pylint. The blacklist is stored in
> scripts/ci/pylint_todo.txt. Every subissue relates to one or more files on
> the blacklist. Once you start on an issue:
> # (running scripts/ci/ci_pylint.sh on master should produce no messages)
> # Remove the files mentioned in your issue from the blacklist
> # Run scripts/ci/ci_pylint.sh to see all messages on the no longer
> blacklisted files
> # Fix all messages and create PR
> *Why a separate blacklist file and not use Pylint's --ignore-pattern to
> ignore files?*
> --ignore-pattern only works on base filenames, not paths.
> *Why don't you blacklist patterns, where 1 line relates to 1 JIRA issue?*
> Creating a list of non-overlapping patterns proved difficult, this was the
> pragmatic solution.
> *Rule X is too strict. Can we disable it?*
> In the first PR ([https://github.com/apache/airflow/pull/5238]) we made a
> choice on every error found on Airflow master back then. While at occasions
> it might seem harsh to be strict on the code, Airflow is an open source
> project with many contributors from all over the world. Others read the code
> without the thought process you put into the code and it helps to have e.g.
> descriptive variable names, docstrings and sticking to Python conventions.
> This helps the collaboration between everybody and even your future self.
> Typically, this question suggests one is trying to lower the boundaries. If
> you believe there is a valid reason for doing so, please add it to the PR and
> explain the reason.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
