Skip to content

Better docs required for 2 'design' checkers #9174

Open
@phormio

Description

@phormio

Pylint has 2 checkers named design:

  1. a standard checker;
  2. an optional checker which can be loaded by specifying --load-plugin=pylint.extensions.mccabe.

That confused me, because I don't want the standard design checker, and I thought I was avoiding it by not loading pylint.extensions.mccabe, but I was wrong. I suggest making this clearer in the documentation.

There is an additional problem in the documentation. In the section for the standard design checker, --max-complexity is listed, even though it is only available if you load pylint.extensions.mccabe. That's clear from the following shell script:

#!/bin/sh

echo Pylint details:
echo
pylint --version
echo

echo Without plugin:
echo
pylint --help |
  egrep max-complexity
echo

echo With plugin:
echo
pylint --load-plugins=pylint.extensions.mccabe --help |
  egrep max-complexity

When I run that, I get:

Pylint details:

pylint 3.0.1
astroid 3.0.1
Python 3.12.0 (main, Oct  3 2023, 04:51:45) [GCC 10.2.1 20210110]

Without plugin:


With plugin:

  --max-complexity <int>

Metadata

Metadata

Assignees

No one assigned

    Labels

    Documentation 📗Needs PRThis issue is accepted, sufficiently specified and now needs an implementation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions