aw-was-here commented on a change in pull request #144: URL: https://github.com/apache/yetus/pull/144#discussion_r500377881
########## File path: asf-site-src/source/documentation/in-progress/precommit/plugins/pylint.html.md ########## @@ -0,0 +1,53 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Name + +pylint + +# Category + +Test + +# Description + +Runs [pylint](http://pylint.org/) against PYthon code. + +# Environment Variables + +None + +# Options + +| Option | Notes | +|:---------|:------| +| `--pylint=<file>` | Location of the `pylint` binary if it is not on the path. Default is 'pylint'. | +| `--pylint-pip-cmd=<file>` | Location of the `pip` binary for install requirements.txt files. Default is 'pip'. | +| `--pylint-rcfile=<file>` | Location of the `.pylintrc` file to override `pylint` default. | +| `--pylint-requirements=<bool>` | Process any `requirements.txt` file. Default is 'false'. | +| `--pylint-use-user=<bool>` | Use `--user` for processing the `requirements.txt` file. Default is 'true'. | + +# Docker Notes + +The default Apache Yetus image comes with `pip2`/`pylint2` for Python 2.x support and `pip3`/`pylint3` for Python 3.x support. +The `pip` and `pylint` point to the Python 3.x versions. Review comment: While working on the GitHub Actions support, I was thinking about some sort of combo too. Within the container, that makes sense. But what about outside of it? So I punted on it for now. But yeah, I feel like a short-cut here would make a lot of sense. ---------------------------------------------------------------- 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]
