vhdl-style-guide/docs
JHertz5 97dca812e4 Issue#1251: Updated rule group docs for function_508 and procedure_509. 2024-10-16 21:46:15 +01:00
..
developing Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
editor_integration Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
img Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
processes Issue#1119: Adding documentation for contributers (#1162) 2024-04-04 06:52:42 -05:00
rule_groups Issue#1251: Updated rule group docs for function_508 and procedure_509. 2024-10-16 21:46:15 +01:00
theory_of_operation Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
tool_integration style: apply codespell 2024-03-24 21:16:34 +02:00
after_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
alias_declaration_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
api.rst Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
architecture_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
assert_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
attribute_declaration_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
attribute_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
attribute_specification_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
bit_string_literal_rules.rst Issue#1236: Rule for case in hexadecimal constants and base specifier (#1237) 2024-10-07 20:09:53 -05:00
block_comment_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
block_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
case_generate_alternative_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
case_generate_statement_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
case_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
code_tags.rst Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
comment_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
component_rules.rst Issue#1178: Adding rule component_022 to add or remove optional component_simple_name. (#1179) 2024-06-14 07:04:07 -05:00
concurrent_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
conditional_expressions_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
conditional_waveforms_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
conf.py Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
configuring.rst Issue#1176: Updating rule instantiation_005 to allow for adding or remmoving carriage returns. (#1180) 2024-06-19 05:18:52 -05:00
configuring_array_multiline_structure_rules.rst style: remove trailing spaces 2024-03-24 21:16:35 +02:00
configuring_blank_lines.rst Issue#1065: Adding 'require_blank_line_unless_pragma' to blank line rules (#1068) 2023-12-17 16:59:55 -06:00
configuring_block_comments.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_comment_keywords.rst Issue#927: Adding checks for keywords in comments. (#934) 2023-04-11 10:48:39 -05:00
configuring_conditional_multiline_indent_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
configuring_consecutive_blank_line_rules.rst Updates for issue #846 (#848) 2022-10-21 06:41:17 -05:00
configuring_disabled_rules.rst Issue#1112 Corrected list of disabled rules and added unit test to verify list. (#1113) 2024-01-21 13:30:18 -06:00
configuring_identifier_alignment_rules.rst style: remove trailing spaces 2024-03-24 21:16:35 +02:00
configuring_indent_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
configuring_indentation.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
configuring_keyword_alignment_rules.rst Issue#1107: Adding option to process_028 to allow for alignment of close parenthesis. (#1116) 2024-01-24 06:56:17 -06:00
configuring_length_rules.rst style: apply codespell 2024-03-24 21:16:34 +02:00
configuring_move_token_rules.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_multiline_assert_rule.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
configuring_multiline_constraint_rules.rst Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
configuring_multiline_indent_rules.rst Issue#1207: Fixing default values in multiline indent documentation. (#1208) 2024-09-22 20:46:58 -05:00
configuring_number_of_signals_in_signal_declaration.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
configuring_optional_items.rst Issue#1196: Adding rules to check for subprogram designators. (#1197) 2024-07-12 03:14:37 -05:00
configuring_overview.rst Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
configuring_port_map_new_line.rst Issue#1214: Corrected label tag for _configuring-port-map-new-line. (#1215) 2024-09-08 20:06:00 -05:00
configuring_port_mode_alignment.rst Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
configuring_pragmas.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
configuring_prefix_and_suffix_rules.rst Issue#1156: Changed prefix/suffix exceptions to allow for regular expressions. (#1159) 2024-04-02 06:47:51 -05:00
configuring_previous_line_rules.rst style: remove trailing spaces 2024-03-24 21:16:35 +02:00
configuring_procedure_call_statement_rules.rst Issue#1106 Corrections to procedure call docs. (#1109) 2024-01-21 12:42:40 -06:00
configuring_rule_groups.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
configuring_selected_assignment_structure_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
configuring_simple_multiline_structure_rules.rst style: apply codespell 2024-03-24 21:16:34 +02:00
configuring_subprogram_specification_statement_rules.rst Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
configuring_type_of_instantiations.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_uppercase_and_lowercase_rules.rst Issue#1251: Updated docstrings and docs for rule groups. 2024-10-15 20:02:57 +01:00
configuring_use_clause_indenting.rst Issue#1163: Fixing documentation on use clause indenting configuration. (#1164) 2024-04-04 20:16:45 -05:00
configuring_vhdl_reserved_words.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
configuring_whitespace_after_comment_rules.rst style: remove trailing spaces 2024-03-24 21:16:35 +02:00
configuring_whitespace_rules.rst Issue#1170: Adding rules to enforce spaces before generic map and port map assignment operators. (#1173) 2024-10-02 21:47:19 -05:00
constant_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
context_ref_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
context_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
continuous_integration_servers.rst style: apply codespell 2024-03-24 21:16:34 +02:00
contributing.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
declarative_part_rules.rst Issue 864 (#895) 2022-12-13 18:05:24 -06:00
element_association_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
entity_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
entity_specification_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
example_configuration_json_file.json style: apply json 2024-03-24 21:16:35 +02:00
exit_statement_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
exponent_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
external_constant_name_rules.rst Issue#1170: Adding rules to enforce spaces before generic map and port map assignment operators. (#1173) 2024-10-02 21:47:19 -05:00
external_signal_name_rules.rst Issue#1170: Adding rules to enforce spaces before generic map and port map assignment operators. (#1173) 2024-10-02 21:47:19 -05:00
external_variable_name_rules.rst Issue#1170: Adding rules to enforce spaces before generic map and port map assignment operators. (#1173) 2024-10-02 21:47:19 -05:00
file_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
for_generate_statement_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
for_loop_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
formatting_terminal_output.rst Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
function_rules.rst Issue#1251: Updated docs for function_508 and procedure_509. 2024-10-16 19:39:28 +01:00
gallery.rst Minor updates to documentation. 2022-10-12 07:51:48 -05:00
generate_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
generic_map_rules.rst Issue#1170: Adding rules to enforce spaces before generic map and port map assignment operators. (#1173) 2024-10-02 21:47:19 -05:00
generic_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
icons.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
ieee_rules.rst Issue#1251: Updated docs for function_508 and procedure_509. 2024-10-16 19:39:28 +01:00
if_generate_statement_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
if_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
includes.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
index.rst Issue#1119: Adding documentation for contributers (#1162) 2024-04-04 06:52:42 -05:00
installing.rst docs: update installation methods 2024-03-27 20:17:12 -05:00
instantiation_rules.rst Issue#1176: Updating rule instantiation_005 to allow for adding or remmoving carriage returns. (#1180) 2024-06-19 05:18:52 -05:00
iteration_scheme_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
length_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
library_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
links.rst Issue#1176: Updating rule instantiation_005 to allow for adding or remmoving carriage returns. (#1180) 2024-06-19 05:18:52 -05:00
localizing.rst Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
logical_operator_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
loop_statement_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
multiple_configurations.rst Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size (#1115) 2024-02-18 15:17:56 -06:00
notepad_pp.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
overview.rst Minor updates to documentation. 2022-10-12 07:51:48 -05:00
package_body_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
package_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
phases.rst Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
port_map_rules.rst Issue#1170: Adding rules to enforce spaces before generic map and port map assignment operators. (#1173) 2024-10-02 21:47:19 -05:00
port_rules.rst Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
pragma_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
pragmas.rst Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
procedure_call_rules.rst Issue#1251: Updated docstrings and docs for rules function_507, procedure_508, and procedure_call_502. 2024-10-15 19:50:27 +01:00
procedure_rules.rst Issue#1251: Updated docs for function_508 and procedure_509. 2024-10-16 19:39:28 +01:00
process_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
range_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
record_type_definition_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
release_notes.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
report_statement_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
reserved_rules.rst Issue-1225 vsg_rule_doc_gen script does not run. (#1226) 2024-09-08 19:51:31 -05:00
return_statement_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
rule_groups.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
rule_severity.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
rules.rst Issue#1236: Rule for case in hexadecimal constants and base specifier (#1237) 2024-10-07 20:09:53 -05:00
selected_assignment_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
sequential_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
signal_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
source_file_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
styles.rst Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size (#1115) 2024-02-18 15:17:56 -06:00
subprogram_body_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
subtype_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
type_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
unfixable_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
usage.rst Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
use_clause_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
variable_assignment_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
variable_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
vsg.rule_list.rst Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
vsg.vhdlFile.rst Attempting to fix ReadTheDocs build. 2021-10-28 08:00:34 -05:00
wait_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
when_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
while_loop_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
whitespace_rules.rst Issue#1216: Added escape characters for "**" in docs. (#1217) 2024-09-08 20:01:16 -05:00
with_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00