Commit Graph

21 Commits

Author SHA1 Message Date
JHertz5 8174cab017
Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
JHertz5 49a4924be3
Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
Alon Bar-Lev baf22da660 style: apply end-of-file-fixer
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev f9c2653e54 style: apply codespell
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:34 +02:00
Alon Bar-Lev b4d5c4e5d6 cleanup: use super() to call parent
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 18:48:35 +02:00
JHertz5 431cdb92c5
Issue#1117 Modifed initialisation of the `Rule` class's `name` and `identifier` attributes to reduce duplication. (#1118)
* Issue#1117 Modifed initialisation of the `Rule` class's `identifier` property to reduce duplication.

* Issue#1117 Modifed initialisation of the `Rule` class's `unique_id` property to make the `identifier` input redundant.

* Issue#1117: Updated Rule.name attribute to be initialised from the class's `__module__` variable.
Modified `deprecated_rule` to not initialise `name` and `identifier` attributes.
Modified rule_localized_001 to force the local rule's `name` since this can't be extracted from the module.
Modified test_rule to force Rule's `name`, `identifier` and `unique_id` in some tests.

* Issue#1117: Removed now-redundant name and identifier input arguments on rule `__init__` methods.
Updated rule_localized_001 to force the rule's name.
Update the local rules documentation.

* Issue#1117: Removed unused exception in get_rule_name.

* Issue#1117: Updates after merging master.

* Converting match case to if statement to support python pre version 3.10Converting match case to if statement to support python pre version 3.10.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2024-02-04 15:23:23 -06:00
Jeremiah Leary 6e58ab4a89 Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
Jeremiah Leary 8fb0875376 Attempting to fix ReadTheDocs build. 2021-10-28 07:39:54 -05:00
Jeremiah Leary bf51e6c02e Updating docs to prepare for release 3.0.0. 2021-03-16 08:18:37 -05:00
Emil Vanherp 73420cdca2
remove trailing whitespace 2021-01-11 21:55:56 +01:00
Jeremiah Leary 610c21d649 Updates for issue #451
1)  Adding links in documentation to which rules use prefix and suffix rules.
  2)  Fixing documentation build issues
2020-12-05 16:02:23 -06:00
Jeremiah C Leary 6b4a45791d Updates for issue #362
Changing utils.get_violation_linenumber to utils.get_violation_line_number.
2020-04-01 21:11:38 -05:00
Jeremiah C Leary 725dd544ee Merge branch 'master' into issue-362
Pulling in latest changes from master to avoid rework.
2020-03-29 13:27:19 -05:00
Jeremiah C Leary e6d691ca06 Updates for issue #362:
Adding documentation for the violation dictionary.
2020-03-29 08:46:48 -05:00
Jeremiah C Leary 4437e19f37 Updates for issue #354
Changed VSG output format to improve readability:

  1)  Updated documentation
  2)  Refactored rule and rule_list to move reporting to new report module
      a)  Removed rule.report_violations method
      b)  Added rule.get_violations_at_line method
  3)  Added vsg.report module
      a)  Added individual VSG and syntastic output files
  4)  Updated tests
2020-03-25 16:34:22 -05:00
Jeremiah C Leary 8c8d89b3e6 Updates for issue #231:
Added more documentation on how to write a rule.
Added comments to methods of rule class.
2019-06-09 15:29:18 -05:00
Jeremiah C Leary 43d63c6b3b Updating documentation. 2019-03-02 15:26:57 -06:00
Jeremiah C Leary 7591715a1a Updating documentation. 2018-05-21 04:56:57 -05:00
Jeremiah C Leary eecd0d1889 Renaming document file. 2017-12-28 20:58:22 -06:00
Jeremiah C Leary c18247f926 Updating grammar in localizing documentation. 2017-12-23 21:20:47 -06:00
Jeremiah C Leary 731a437702 Adding localizing user documentation. 2017-12-23 20:44:43 -06:00