Skip to content

Move rule descriptions to rule class docstrings

KiCad Bot requested to merge github/fork/Ratfink/rule-docstrings into master

Created by: Ratfink

As I wrote in #220 (closed), the rule class docstrings seem like a more sensible place for rule descriptions than burying them in the __init__ method. I offered to make this change a couple of months ago, and have seen no objections, so here it is.

While moving the descriptions, I changed them all to match the one-line rule names in KLC 3.0.11, the current revision. All the docstrings I touched now come at least reasonably close to following PEP 257. Hooray for good code style!

In moving the descriptions out of the constructor, many rule classes no longer need to define their own constructors at all, so overall this reduces how much code we have to maintain.

Fixes #220 (closed).

Edited by cpresser

Merge request reports