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

Rule function_018 is documented but does not exist #946

Closed
flyinged opened this issue Apr 24, 2023 · 5 comments
Closed

Rule function_018 is documented but does not exist #946

flyinged opened this issue Apr 24, 2023 · 5 comments
Labels

Comments

@flyinged
Copy link

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 vsg is 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

@flyinged flyinged added the bug label Apr 24, 2023
@jeremiah-c-leary
Copy link
Owner

Morning @flyinged,

Rule function_018 is documented but does not exist

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

--Jeremy

@flyinged
Copy link
Author

Hi @jeremiah-c-leary

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

Correct.
A.

@JHertz5
Copy link
Contributor

JHertz5 commented Jul 27, 2023

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
Copy link
Owner

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
Copy link
Author

Ok. Problem solved. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

No branches or pull requests

3 participants