Commit Graph

9 Commits

Author SHA1 Message Date
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
Jeremiah Leary ad87ea65ee Changing links to configuration documentation into ReST substitations.
Re-ordered configuration documentation entries so they are alphabetical.
2022-02-05 15:13:48 -06:00
Jeremiah Leary 3dd48d9464
Updates for issue #624 (#708)
* Updates for issue #624

Adding documentation for new loop rules.

* Updating another alternative output for json export.

* Temporarily reducing documentation for loop statements.

* Updating test to use correct json file for comparison.

* Adding rule loop_statement_500.

* Adding rule loop_statement_501.

* Adding rule loop_statement_502.

* Added rule loop_statement_301.

* Adding rule loop_statement_100.

* Adding rule loop_statement_101.

* Adding rule loop_statement_102.

* Refactoring base rule single_space_before_token.

* Refactoring to improve readability.
Minor formatting updates.

* Minor formatting fixes.

* Refactoring base rule single_space_after_token to improve readability.

* Refactoring to improve readability.

* Adding rule loop_statement_001.

* Added rule loop_statement_002.

* Adding rule loop_statement_003.

* Adding rule loop_statement_004
Adding rule loop_statement_201

* Adding rule loop_statement_202.

* Adding rule loop_statement_203.
Fixing documentation for rule loop_statement_201.

* Minor formatting changes.

* Moved rule for_loop_002 to loop_statement_302.
Minor grammar updates in documentation.

* Moving rule for_loop_003 to loop_statement_503.

* Clarifying documentation on rule loop_statement_503.

* Moved rule for_loop_005 to loop_statement_104:

* Refactoring to improve readability.

* Adding rule loop_statment_504.

* Adding rule loop_statement_005.

* Adding rule loop_statement_007.

* Adding rule loop_statement_006.

* Refactoring to improve readability.

* Deprecated rule while_loop_002 as it was a duplicate of rule loop_statement_302.

* Fixing solution text.

* Adding rule iteration_scheme_500.

* Adding rule iteration_scheme_501.

* Adding rule iteration_scheme_100.

* Adding rule iteration_scheme_101.

* Moved rule while_loop_001 to rule iteration_scheme_300.

* Moving rule for_loop_001 to iteration_scheme_301.

* Adding rule loop_statement_200.

* Adjusting number of tokens grabbed to fix error.
2022-02-05 06:15:47 -06:00
Jeremiah Leary f8f5f77c58
Updates for issue #651 (#662)
* Updates for issue #651

Initial attempt at adding rule groups.

  1)  Updated documentation
  2)  Added indent group
  3)  Added tests

* Addressing CodeClimate issues.

* Additional code climate updates.

* Renaming depricated to deprecated.

Adding tests to improve code coverage.

* Adding length group and updating documentation.

* Adding indent labels to rule documentation.

* Adding blank_line group.

* Minor documentation update.

* Adding more rules to the blank_line group.

* Adding blank_line label to blank line rules in documentation.

* Adding whitespace rule group

* Adding case group.

* Adding structure rule group:

  1)  Addings structure rule group object
  2)  Updated base rules which should utilize the rule group

* Adding more base rules to the whitespace rule group.

* Adding more base rules to the case rule group.

* Adding naming rule group:

  1)  Added naming rule group
  2)  Assigned base rules to the naming rule group

* Adding alignment rule group:

  1)  Added alignment rule group
  2)  Added base rules to alignment rule group

* Assigning more rules to rule groups.

* Adding last rule to a rule group.
Fixing error introduced into whitespace_001

* Assigning sub groups to architecture rules.

* Updating after rules documentation to add rule group.

* Adding rule group to assert rule documentation

* Updating attribute_declaration rules rule group.

* Adding program to generate rule documentation:

  1)  Added bin/vsg_rule_doc_gen
  2)  Added tests
  3)  Copied existing documentation into rule doc strings for the following rule classes:
      a)  after
      b)  architecture
      c)  assert_statement
      d)  attribute
      e)  attribute_declaration
      f)  attribute_specification
      g)  block
  4)  Partially update deprecated rules to they could be processed

* Converting block_comment documentation.

* Converting case_rule documentation.

* Converting comment rule documentation.

* Converting component documentation to doc strings.

* Converting concurrent rule documentation to doc strings.

* Convert constant docs to doc strings.

* Converting context rule doc to doc strings.

* Fixing failing tests.

* Converting context reference doc to doc strings.

* Converting entity doc rules to doc strings.

* Converting entity_specification rule doc to doc strings.

* Converting exit_statement rule doc to doc strings.

* Converting file_statement rule docs into doc strings.

* Converting for_loop rule doc to doc strings.

* Converting function rule doc to doc strings.

* Converting generate rules doc to doc strings.

* Converting generic rule doc to doc strings.

* Converting generic_map rule doc to doc strings.

* Converting if rule docs to doc strings.

* Converting instantiation rule doc to doc strings.

* Converting length rule doc to doc strings.

* Converting library rule doc to doc strings.

* Convert loop_statement rule doc to doc strings.

* Converting package rule docs to doc strings.

* Converting package_body rule doc to doc strings.

* Converting port rule doc to doc strings.

* Converting port_map rules doc to doc strings.

* Converting procedure rule doc to doc strings.

* Converting procedure_call rule doc to doc strings.

* Converting process rule doc to doc strings.

* Converting range rule doc to doc strings.

* Converting report_statement rule doc to doc strings.

* Converting sequential rule doc to doc strings.

* Converting signal rule doc to doc strings.

* Converting source_file rule doc to doc strings.

* Converting subprogram_body rule doc to doc strings.

* Converting subtype rule doc to doc strings.

* Converting type rule doc to doc strings.

* Converting variable rule doc to doc strings.

* Converting variable_assignment rule doc to doc strings.

* Converting wait rule doc to doc strings.

* Converting when rule doc to doc strings.

* Converting while_loop rule doc to doc strings.

* Converting whitespace rule doc to doc strings.

* Converting with rule doc to doc strings.

* Fixing tests due to further refinements of rule groups.

* Removing generated doc files after tests.

* Updating documentation to include rule group information.

* Removing trailing whitespace.

* Minor formatting fixes for documentation.

* Fixing issues for codacy.

* Skipping currently failing tests so I can address coding issues.

* Removing unused libraries.

* Minor formatting issues resolved.

* WIP:  Setting desired test input.

NOTE:  tests fail as I need to implement fixes.

* Improving testing of rule groups.

* Enhancing test so it will pass.

* Updates for codacy.
2022-01-01 17:46:43 -06:00
Jeremiah Leary 6e58ab4a89 Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
Jeremiah Leary 3610020b78 Attempting to fix ReadTheDocs build. 2021-10-28 07:32:04 -05:00
Jeremiah Leary 446a3ebe31 Updates for issue #540
Adding icons to all rules.
2021-04-01 22:02:05 -05:00
Michał Kruszewski 911cf3a692 Improve while loops rules documentation. 2020-05-03 10:29:45 +02:00
Jeremiah C Leary 006ad3a616 Updates for issue #107
1)  Added classifier for while loops
  2)  Updated existing classifiers to handle while loops
  3)  Added tests
  4)  Added documentation
  5)  Added two rules for while loops
2017-12-06 19:53:30 -06:00