jeremiah-c-leary / vhdl-style-guide

Style guide enforcement for VHDL
GNU General Public License v3.0
182 stars 38 forks source link

"Configuring Concurrent Structure Rules" page is redundant and duplicates "Configuring Simple Multiline Structure Rules" #1008

Closed JHertz5 closed 10 months ago

JHertz5 commented 12 months ago

Environment 3.17.0

Describe the bug The page https://vhdl-style-guide.readthedocs.io/en/latest/configuring_conditional_expressions_structure_rules.html is redundant and duplicates the information in https://vhdl-style-guide.readthedocs.io/en/latest/configuring_simple_multiline_structure_rules.html#configuring-simple-multiline-structure-rules. These rules both cover conditional assignments, but the "Concurrent Structure" page only links to concurrent_011, wheras the "Simple Multiline Structure" page links to all three conditional assignement rules. The three rules all link to the "Simple Multiline Structure" page, including concurrent_011, and no rules link to the "Concurrent Structure" page. Additionally, the name in the link and the name in the title of the "Concurrent Structure" page conflict, adding to the confusion.

Expected behavior I propose that we remove the redundant page docs/configuring_conditional_expressions_structure_rules.rst

Screenshots None

Additional context None

jeremiah-c-leary commented 11 months ago

Good Evening @JHertz5 ,

I concur with your proposal to remove https://vhdl-style-guide.readthedocs.io/en/latest/configuring_conditional_expressions_structure_rules.html.

I have an update to the documentation on the issue-1008 branch and will merge it into master in a couple of days if you want to check my changes.

Regards,

--Jeremy