Check that all rules have descriptions

[calumy]

Check that all rules have the headers "What it does" and "Why is this bad?".

[github-actions]

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     13.9±0.03ms     2.9 MB/sec    1.00     13.9±0.02ms     2.9 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.3±0.00ms     5.0 MB/sec    1.00      3.3±0.00ms     5.0 MB/sec
linter/all-rules/numpy/globals.py          1.00    410.9±0.84µs     7.2 MB/sec    1.00    412.1±0.88µs     7.2 MB/sec
linter/all-rules/pydantic/types.py         1.00      5.7±0.01ms     4.4 MB/sec    1.00      5.8±0.01ms     4.4 MB/sec
linter/default-rules/large/dataset.py      1.00      6.8±0.01ms     6.0 MB/sec    1.01      6.9±0.01ms     5.9 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1473.7±2.94µs    11.3 MB/sec    1.00   1473.6±1.75µs    11.3 MB/sec
linter/default-rules/numpy/globals.py      1.00    161.0±0.38µs    18.3 MB/sec    1.01    162.7±1.26µs    18.1 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.1±0.00ms     8.3 MB/sec    1.01      3.1±0.01ms     8.3 MB/sec
parser/large/dataset.py                    1.00      5.4±0.00ms     7.5 MB/sec    1.10      6.0±0.00ms     6.8 MB/sec
parser/numpy/ctypeslib.py                  1.00   1061.1±0.63µs    15.7 MB/sec    1.08   1147.1±0.59µs    14.5 MB/sec
parser/numpy/globals.py                    1.00    107.9±0.17µs    27.3 MB/sec    1.06    114.8±0.20µs    25.7 MB/sec
parser/pydantic/types.py                   1.00      2.3±0.00ms    11.0 MB/sec    1.09      2.5±0.00ms    10.2 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.06     19.5±0.77ms     2.1 MB/sec    1.00     18.4±0.83ms     2.2 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.07      5.0±0.23ms     3.3 MB/sec    1.00      4.7±0.26ms     3.6 MB/sec
linter/all-rules/numpy/globals.py          1.07   600.8±39.45µs     4.9 MB/sec    1.00   562.8±37.37µs     5.2 MB/sec
linter/all-rules/pydantic/types.py         1.04      8.2±0.38ms     3.1 MB/sec    1.00      7.9±0.44ms     3.2 MB/sec
linter/default-rules/large/dataset.py      1.06      9.8±0.46ms     4.1 MB/sec    1.00      9.3±0.33ms     4.4 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.01      2.1±0.13ms     7.8 MB/sec    1.00      2.1±0.13ms     7.9 MB/sec
linter/default-rules/numpy/globals.py      1.03   251.7±12.52µs    11.7 MB/sec    1.00   244.9±16.52µs    12.0 MB/sec
linter/default-rules/pydantic/types.py     1.04      4.6±0.44ms     5.6 MB/sec    1.00      4.4±0.26ms     5.8 MB/sec
parser/large/dataset.py                    1.01      8.1±0.39ms     5.0 MB/sec    1.00      8.0±0.41ms     5.1 MB/sec
parser/numpy/ctypeslib.py                  1.02  1622.5±71.19µs    10.3 MB/sec    1.00  1596.1±88.40µs    10.4 MB/sec
parser/numpy/globals.py                    1.02    159.3±9.45µs    18.5 MB/sec    1.00   156.4±10.36µs    18.9 MB/sec
parser/pydantic/types.py                   1.00      3.5±0.19ms     7.3 MB/sec    1.02      3.6±0.15ms     7.1 MB/sec