search

jeremiah-c-leary / vhdl-style-guide

Style guide enforcement for VHDL
GNU General Public License v3.0
177 stars 38 forks source link

The list of disabled rules in "Configuring Disabled Rules" is incomplete #1112

Closed JHertz5 closed 5 months ago

JHertz5 commented 5 months ago

Environment

$ ./bin//vsg -v
VHDL Style Guide (VSG) version: 3.20.0.dev8
Git commit SHA: 23b63ebf

Describe the bug There are many disabled rules missing from the list at the bottom of Configuring Disabled Rules.

To Reproduce Steps to reproduce the behavior:

  1. Configuring Disabled Rules.
  2. Observe that disabled rules type_100, type_200, and type_600 are all missing from the list. These are among many other missing rules.

Expected behavior The page should contain a complete list of the disabled rules. A page like this is very difficult to maintain when not automatically generated or tested. Even if the page is corrected now, errors will creep in again unless a test is put in place.

JHertz5 commented 5 months ago

I have raised PR #1113 to correct the page's rule list and to add a unit test to verify the list of rules in the future. Any feedback is very welcome.

jeremiah-c-leary commented 5 months ago

Afternoon @JHertz5 ,

A page like this is very difficult to maintain when not automatically generated or tested. Even if the page is corrected now, errors will creep in again unless a test is put in place.

Completely agree. Thanks for added a test to enforce the disabled rule list.

I will get this merged to master.

--Jeremy