This repository has been archived by the owner on Oct 2, 2020. It is now read-only.
Move rule descriptions to rule class docstrings #243
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As I wrote in KiCad#220, the rule class docstrings seem like a more sensible place for rule descriptions. 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. 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.
|
Good idea. However we have a merge conflict now as i merged other stuff. Could you look into that? |
|
The conflict has been resolved; can this be merged now? |
|
@poeschlr |
|
It is a good idea in general but i suspect @Ratfink will no longer work on this. Maybe somebody with a lot of time on their hand will continue this effort. Which is why i marked it as abandoned as users can then search for this label for things they can help with. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As I wrote in #220, 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.