jeremiah-c-leary / vhdl-style-guide

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

Rule function_018 is documented but does not exist #946

Closed flyinged closed 1 year ago

flyinged commented 1 year ago

Environment Windows 10, WSL2, 3.14.0+zip.file

Describe the bug Rule function_018 is documented but does not exist

To Reproduce Run the following command: vsg -rc function_018

Result: ERROR: rule function_018 was not found.

The rule is actually not enforced: if vsgis run on code that matches the following pattern:

function func1 ( ... ) return ret_type is
begin
...
end;

The "end" statement won't be fixed, and no message will be returned from vsg.

Expected behavior Configuration of rule should be printed

jeremiah-c-leary commented 1 year ago

Morning @flyinged,

Rule function_018 is documented but does not exist

Are you referring to the documentation on read-the-docs?

--Jeremy

flyinged commented 1 year ago

Hi @jeremiah-c-leary

Are you referring to the documentation on read-the-docs?

Correct. A.

JHertz5 commented 1 year ago

Hi @flyinged. You've mentioned in your original comment that you are using v3.14.0. The documentation for v3.14.0 does not include function_018.

It looks like function_018 was added after that version. I am running v3.16.0 and vsg -rc function_018 prints out the configuration as expected.

I suggest that you either update the version of vsg, or use the documentation that corresponds to the version that you are using. You can modify the version of the documentation in the bottom left of the browser window on readthedocs.io

jeremiah-c-leary commented 1 year ago

Evening @flyinged ,

You can pick the version of documentation by clicking on the following at the bottom left of the read-the-docs window:

Image

Let me know if this addresses your question.

--Jeremy

flyinged commented 1 year ago

Ok. Problem solved. Thanks