Skip to content

Commit 133af09

Browse files
jack-mcivorJack McIvorhenryiii
authored
docs: rename PyLint -> Pylint (#579)
* Rename PyLint -> Pylint * chore: disallow incorrectly stylized pylint * Update noxfile.py --------- Co-authored-by: Jack McIvor <[email protected]> Co-authored-by: Henry Schreiner <[email protected]>
1 parent 99503a6 commit 133af09

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ repos:
7777
- id: disallow-caps
7878
name: Disallow improper capitalization
7979
language: pygrep
80-
entry: PyBind|Numpy|Cmake|CCache|Github|PyTest|RST
80+
entry: PyBind|Numpy|Cmake|CCache|Github|PyTest|RST|PyLint
8181
exclude: (.pre-commit-config.yaml|docs/pages/guides/style\.md)$
8282
- id: disallow-words
8383
name: Disallow certain words

docs/pages/guides/style.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ Here are some good error codes to enable on most (but not all!) projects:
306306
- `PGH`: Checks for patterns, such as type ignores or noqa's without a specific
307307
error code.
308308
- `PL`: A set of four code groups that cover some (200 or so out of 600 rules)
309-
of PyLint.
309+
of Pylint.
310310
- `PT`: Helps tests follow best pytest practices. A few codes are not ideal, but
311311
many are helpful.
312312
- `PTH`: Want to move to using modern pathlib? This will help. There are some
@@ -829,12 +829,12 @@ schemas, and you can load them via URL. It work on JSON, YAML, and TOML.
829829
- id: check-readthedocs
830830
```
831831

832-
## PyLint (noisy)
832+
## Pylint (noisy)
833833

834-
PyLint is very opinionated, with a high signal-to-noise ratio. However, by
834+
Pylint is very opinionated, with a high signal-to-noise ratio. However, by
835835
limiting the default checks or by starting off a new project using them, you can
836836
get some very nice linting, including catching some problematic code that
837-
otherwise is hard to catch. PyLint is generally not a good candidate for
837+
otherwise is hard to catch. Pylint is generally not a good candidate for
838838
pre-commit, since it needs to have your package installed - it is less static of
839839
check than Ruff or Flake8. Here is a suggested `pyproject.toml` entry to get you
840840
started:

noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ def rr_lint(session: nox.Session) -> None:
505505
@nox.session
506506
def rr_pylint(session: nox.Session) -> None:
507507
"""
508-
Run PyLint.
508+
Run Pylint.
509509
"""
510510
# This needs to be installed into the package environment, and is slower
511511
# than a pre-commit check

{{cookiecutter.project_name}}/.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
- uses: pre-commit/[email protected]
3131
with:
3232
extra_args: --hook-stage manual --all-files
33-
- name: Run PyLint
33+
- name: Run Pylint
3434
run: pipx run nox -s pylint -- --output-format=github
3535

3636
checks:

{{cookiecutter.project_name}}/noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def lint(session: nox.Session) -> None:
2727
@nox.session
2828
def pylint(session: nox.Session) -> None:
2929
"""
30-
Run PyLint.
30+
Run Pylint.
3131
"""
3232
# This needs to be installed into the package environment, and is slower
3333
# than a pre-commit check

0 commit comments

Comments
 (0)