From 8bb50be79472c38c2f461ba72f7c68c2d27f0dfb Mon Sep 17 00:00:00 2001 From: Adel Hasic <47243901+hasicx@users.noreply.github.com> Date: Wed, 29 May 2024 11:52:15 +0200 Subject: [PATCH] pylint: add package and module examples (#12858) --- pages/common/pylint.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/pages/common/pylint.md b/pages/common/pylint.md index c9b838e5e..450fa5c60 100644 --- a/pages/common/pylint.md +++ b/pages/common/pylint.md @@ -7,6 +7,14 @@ `pylint {{path/to/file.py}}` +- Lint a package or module (must be importable; no `.py` suffix): + +`pylint {{package_or_module}}` + +- Lint a package from a directory path (must contain an `__init__.py` file): + +`pylint {{path/to/directory}}` + - Lint a file and use a configuration file (usually named `pylintrc`): `pylint --rcfile {{path/to/pylintrc}} {{path/to/file.py}}`