Skip to content

Commit

Permalink
BLD: Remove pylint (#28)
Browse files Browse the repository at this point in the history
As per #20. This removes all references to `pylint` in favour of relying
on whatever opinionated standards which `black` has gone with.

- Remove Github Actions Workflow
- Remove pylint section in pyproject.toml
- Update README section on contributing to be more generic. ("Make
  sure all configured github actions pass" rather than naming specific
  checks).

I haven't touched `flake8` for now, since in theory it catches a bunch
of stuff which black doesn't care about, but which generally keeps
codebases clean (e.g. checking for unused variables, imports etc). My
instinct is to leave flake8 in place, unless people very strongly feel
otherwise.
  • Loading branch information
msuriar authored Dec 28, 2022
1 parent 07f74d4 commit bc12960
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 38 deletions.
23 changes: 0 additions & 23 deletions .github/workflows/pylint.yml

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Following this, you should be able to install the requirements with
`python -m pip install -r requirements.txt`

## Contributing
Please ensure pylint and mypy are happy before pushing code.
In the near future we can add in some tests and some github actions to enforce this.
Please ensure all configured github workflows are green before requesting
review.

## Authors
Because of the refactor, this branch wiped out a lot of author information.
Expand Down
14 changes: 1 addition & 13 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,6 @@ module = [
]
ignore_missing_imports = true

[tool.pylint.'MESSAGES CONTROL']
max-line-length = 100
max-attributes = 12
max-args = 10
max-locals = 20
min-public-methods = 0
# accepted short names: i,j,k for iteration
# t for time
# f1,f2 for frequencies
good-names = ["i,j,k,t,f1,f2"]
ignore = ["tests"]

[tool.coverage.run]
source = ["tid"]

Expand All @@ -90,4 +78,4 @@ omit = [
]
exclude_lines = [
"if __name__ == '__main__':"
]
]

0 comments on commit bc12960

Please sign in to comment.