Add python styleguides for use within Data Science and Statistics #59
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added definition of linting
Update python.md
|
What do we think about Black? This can automatically PEP8ify your Python. |
jamesgeddes
suggested changes
Dec 8, 2021
| # paths. | ||
| ignore=CVS | ||
|
|
||
| # Add files or directories matching the regex patterns to the blacklist. The |
There was a problem hiding this comment.
We should really use allow list & deny list.
| # Specify a score threshold to be exceeded before program exits with error. | ||
| fail-under=50 | ||
|
|
||
| # Add files or directories to the blacklist. They should be base names, not |
There was a problem hiding this comment.
We should really use allow list & deny list.
| # pygtk.require(). | ||
| #init-hook= | ||
|
|
||
| # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the |
There was a problem hiding this comment.
Black would be better than Pylint IMO - less to configure and purely PEP8. I get this whole file is for Pylint though 😄
| # Pickle collected data for later comparisons. | ||
| persistent=yes | ||
|
|
||
| # When enabled, pylint would attempt to guess common misconfiguration and emit |
| **What is Linting?** | ||
| A lint, or a linter, is a tool that analyzes your code to flag programming errors, bugs and stylistic errors. Simply put, a linter is a tool that scans your code with the goal of finding issues that could lead to bugs or inconsistencies with code health and style. | ||
|
|
||
| * You should have as a minimum [pylint](https://pylint.org/#install) installed in order to quality check code before merging any Pull Requests. You can find install instructions on the linked homepage and further setup instructions on their [github page](https://github.com/PyCQA/pylint). Here is a [nice tutorial](http://pylint.pycqa.org/en/latest/tutorial.html) should its usage not be clear. |
There was a problem hiding this comment.
- Linting should be done in a Concourse pipeline. We should encourage local installation, but neither rely on it being installed locally or require it.
- Could we use Black over Pylint? Is there a specific need for Pylint?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added styleguides for Python following the rise of Python usage within Data Science, Analysis and Insight. The content currently includes: