search

nautobot / pylint-nautobot

Custom Pylint Rules for Nautobot
https://docs.nautobot.com/projects/pylint-nautobot/en/latest/
Other
4 stars 0 forks source link

FR: Documentation should include a Rules page for easy reference #86

Open cmsirbu opened 4 months ago

cmsirbu commented 4 months 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.

cmsirbu commented 4 months ago

82 has a working example that needs a bit more work and perhaps layout improvements in the rendered docs.

bryanculver commented 1 month ago

Let's also establish a standard where the rule has a somewhat sufficient explanation as to why this rule is in place, which means going back to our current rule set and writing those up.

Better to do this now than have the rule count increase and further increase the tech debt.

Good example: https://pylint.pycqa.org/en/latest/user_guide/messages/convention/consider-using-f-string.html