diff options
| author | Tausif Rahman <tausif.rahman@mongodb.com> | 2022-05-24 22:55:22 +0000 |
|---|---|---|
| committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2022-05-25 17:40:16 +0000 |
| commit | 9ea1d6f0419938770eea612479c75838f75752b7 (patch) | |
| tree | 26b57fa102878dba3251b40f7ddf9c50ab8b275a /docs | |
| parent | 3ad805fea14b2f1d5c5a367f6ec05ece93502f32 (diff) | |
| download | mongo-9ea1d6f0419938770eea612479c75838f75752b7.tar.gz | |
SERVER-66490 Apply pylinters to build system code
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/linting.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/linting.md b/docs/linting.md index a6a13fa2d19..a499505442d 100644 --- a/docs/linting.md +++ b/docs/linting.md @@ -73,6 +73,11 @@ Ex: `buildscripts/pylinters.py lint` | `pydocstyle` | `.pydocstyle` | `pydocstyle --help` | [https://readthedocs.org/projects/pydocstyle/](https://readthedocs.org/projects/pydocstyle/) | | `yapf` | `.style.yapf` | `yapf --help` | [https://github.com/google/yapf](https://github.com/google/yapf) | +### SCons Linters +`buildscripts/pylinters.py` has the `lint-scons` and `fix-scons` commands to lint +and fix SCons and build system related code. Currently `yapf` is the only +linter supported for SCons code. + ## Using SCons for linting You can use SCons to run most of the linters listed above via their corresponding Python wrapper script. SCons also provides the ability to run multiple linters in a single command. At this time, @@ -89,3 +94,4 @@ Here are some examples: | `lint-lint.py` | `quickcpplint.py` | `buildscripts/scons.py lint-lint.py` | | `lint-eslint` | `eslint` | `buildscripts/scons.py lint-eslint` | | `lint-pylinters` | `pylint` `mypy` `pydocstyle` `yapf` | `buildscripts/scons.py lint-pylinters` | +| `lint-sconslinters` | `yapf` | `buildscripts/scons.py lint-sconslinters` | |