summaryrefslogtreecommitdiff
path: root/doc/development_guide
diff options
context:
space:
mode:
authorepenet <6771947+epenet@users.noreply.github.com>2022-06-16 16:09:34 +0200
committerGitHub <noreply@github.com>2022-06-16 16:09:34 +0200
commitbc7f8dac5a1d9ac2a1f6966029f5fc134d139f2f (patch)
treeae178c85ccc22a4876fd0c1a0b30bdbf967a3a15 /doc/development_guide
parentb0a3521323a02bec8043154f63411de3793bfd8b (diff)
downloadpylint-git-bc7f8dac5a1d9ac2a1f6966029f5fc134d139f2f.tar.gz
Add small code sample to custom checker documentation (#6960)
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'doc/development_guide')
-rw-r--r--doc/development_guide/how_tos/custom_checkers.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/development_guide/how_tos/custom_checkers.rst b/doc/development_guide/how_tos/custom_checkers.rst
index eff8cf543..82dc54799 100644
--- a/doc/development_guide/how_tos/custom_checkers.rst
+++ b/doc/development_guide/how_tos/custom_checkers.rst
@@ -113,7 +113,12 @@ It has the following format::
* The ``option-symbol`` is a unique name for the option.
This is used on the command line and in config files.
The hyphen is replaced by an underscore when used in the checker,
- similarly to how you would use ``argparse.Namespace``.
+ similarly to how you would use ``argparse.Namespace``:
+
+ .. code-block:: python
+
+ if not self.linter.config.ignore_ints:
+ ...
Next we'll track when we enter and leave a function.