pylint-nautobot docs should have a page with a table that lists all the messages added by the plugin. All the needed info is in the checker classes.
This info can be generated automatically from code and should be inserted into the docs tree. Rule ids, nautobot version compatibility, rule descriptions are a good starting point.
Use Case
As a developer using pylint-nautobot in my project, I'd like to have an easier way of cross-referencing the output of pylint with the rule descriptions and guidance.
cmsirbu
commented
1 month ago
Proposed Functionality
pylint-nautobot docs should have a page with a table that lists all the messages added by the plugin. All the needed info is in the checker classes.
This info can be generated automatically from code and should be inserted into the docs tree. Rule ids, nautobot version compatibility, rule descriptions are a good starting point.
Use Case
As a developer using pylint-nautobot in my project, I'd like to have an easier way of cross-referencing the output of pylint with the rule descriptions and guidance.