Add documentation: Rule is (auto)fixable

[el-coder-sb]

Is your feature request related to a problem? Please describe. I can´t find any information about if there are any "Configuring Prefix and Suffix Rules" which are fixabel. Or better said: Would be helpful to have the information if a rule is (auto)fixable and if yes under which circumstances (regarding suffixes: surely only if only one allowed suffix ist given)

Describe the solution you'd like A flag or text in the documentation which indicates if a rule is (auto)fixable.

Additional context Somewhat related to #558.

[jeremiah-c-leary]

Morning @el-coder-sb ,

I see your point. I believe there are several rules where the documentation states the user is responsible for fixing the issue. However, being explicit with every rule would be helpful.

I would propose adding another icon...something like:

to each rule that VSG can not fix. This would then link to some new documentation describing the option.

It would be similar to rules that are disabled. Most rules are enabled default so there is not icon. The disabled rules, e.g. package_body_600 have an icon indicating it is disabled.

Would that approach be satisfactory?

Regards,

--Jeremy

[el-coder-sb]

Would that approach be satisfactory?

Yes. Sounds good to me. Thanks for quick reaction!

[jeremiah-c-leary]

Morning @el-coder-sb ,

I pushed the documentation update to the issue-1135 branch. You can build the documentation by following these steps:

$ cd docs
$ make html

The results will be stored in the _build directory. Load the index.html file in your browser.

Let me know if you think there are any changes I should make.

Regards,

--Jeremy

[el-coder-sb]

Thank you very much for your quick solution. Sorry for late response. I have some trouble with my VM where I use VSG. At the moment I´m not able to test. I´ll come back when I got time to fix my VM and test VSG.

[jeremiah-c-leary]

Morning @el-coder-sb ,

Just a ping to see if you were able to check out the updated documentation.

--Jeremy

[el-coder-sb]

@jeremiah-c-leary sorry for late response.

But finally I got time and a running system to test the documentation. Looks very nice!! I think this should be merged.

Thanks for your effort!

[jeremiah-c-leary]

Evening @el-coder-sb ,

No problem. I will get this merged to master.

--Jeremy