Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rethink how rule citation and description work in style-linter #1462

Open
snsokolov opened this issue Sep 16, 2022 · 0 comments
Open

Rethink how rule citation and description work in style-linter #1462

snsokolov opened this issue Sep 16, 2022 · 0 comments
Labels
enhancement New feature or request style-linter Verilog style-linter issues

Comments

@snsokolov
Copy link
Contributor

From the discussion #1455 (comment)

Currently every rule has a citation referring to the Google's Verilog Style Guide (which is not published yet) or some other "unknown" style guide, which is also not published.
So even if the citation is there, it may not be possible for a user (except for those who work at Google) to actually read it.

This is further complicated by the fact that Verilog Linter:

  1. Has many rules which are not part of the Google's VSG and may never be
  2. Some of rules are contradictory to Google's VSG or other rules, like this one so they will never be a part of the same style guide
  3. There is also a PR to override rule descriptions Override style guide citations #817 which I guess is an attempt to make .desc look more like a Style Guide quote

I think we need to rethink how citation and description work in style-linter.

@hzeller

@snsokolov snsokolov added enhancement New feature or request style-linter Verilog style-linter issues labels Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request style-linter Verilog style-linter issues
Projects
None yet
Development

No branches or pull requests

1 participant