jeremiah-c-leary / vhdl-style-guide

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

Issue#1216: Added escape characters for "**" in docs. #1217

Closed JHertz5 closed 2 months ago

JHertz5 commented 3 months ago

Resolves #1216.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.11%. Comparing base (baf22da) to head (06dbde3). Report is 37 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1217 +/- ## ========================================== + Coverage 94.01% 94.11% +0.09% ========================================== Files 1557 1569 +12 Lines 29028 29407 +379 Branches 3414 3472 +58 ========================================== + Hits 27291 27675 +384 + Misses 1303 1299 -4 + Partials 434 433 -1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

JHertz5 commented 3 months ago

It might be of a stretch for every reader to see /*/* in the python comment and know that it means **, plus codeclimate isn't happy about "/*" not being a valid escape sequence. Alternative solutions:

jeremiah-c-leary commented 2 months ago

I think I may end up dropping code climate. Due to the similarities in the code I get a lot of duplicate code warnings so I end up ignoring the code climate report. I suppose I could turn those off though....