Skip to content

Fix Markdown rendering of multiple default values#3526

Merged
schalkms merged 3 commits into
detekt:masterfrom
sschuberth:fix-markdown-rendering
Mar 7, 2021
Merged

Fix Markdown rendering of multiple default values#3526
schalkms merged 3 commits into
detekt:masterfrom
sschuberth:fix-markdown-rendering

Conversation

@sschuberth

Copy link
Copy Markdown
Contributor

Please have a look at the individual commit messages for the details.

As it does not really look good, esp. in Markdown, to have an
enumeration rendered as a code block when surrounded by "(default: ...)"
in regular text, simply turn the enumeration into a comma separated
list.

Fixes detekt#3523.
@sschuberth sschuberth changed the title Fix Markdown rendering of default values Fix Markdown rendering of multiple default values Mar 7, 2021
@codecov

codecov Bot commented Mar 7, 2021

Copy link
Copy Markdown

Codecov Report

Merging #3526 (437728f) into master (2fbb7c9) will increase coverage by 0.02%.
The diff coverage is 66.66%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #3526      +/-   ##
============================================
+ Coverage     77.56%   77.58%   +0.02%     
- Complexity     2825     2826       +1     
============================================
  Files           463      463              
  Lines          8745     8749       +4     
  Branches       1703     1704       +1     
============================================
+ Hits           6783     6788       +5     
  Misses         1038     1038              
+ Partials        924      923       -1     
Impacted Files Coverage Δ Complexity Δ
...gitlab/arturbosch/detekt/generator/out/Markdown.kt 21.42% <0.00%> (ø) 4.00 <0.00> (ø)
...enerator/printer/rulesetpage/RuleSetPagePrinter.kt 87.80% <100.00%> (+0.96%) 16.00 <0.00> (ø)
...osch/detekt/rules/exceptions/SwallowedException.kt 77.35% <0.00%> (+2.35%) 19.00% <0.00%> (+1.00%)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2fbb7c9...437728f. Read the comment docs.

@picklebento picklebento left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for making contributions! I am attaching the screenshot here for other reviewers.
image

@sschuberth

Copy link
Copy Markdown
Contributor Author

Thank you for making contributions!

I'm actually an old contributor who returned, but thanks 😉

I am attaching the screenshot here for other reviewers.

Thanks, and this is how it looked before:

image

@schalkms schalkms merged commit 9cf9f08 into detekt:master Mar 7, 2021
@sschuberth sschuberth deleted the fix-markdown-rendering branch March 8, 2021 07:21
@cortinico cortinico added this to the 1.16.0 milestone Mar 8, 2021
@cortinico cortinico added the housekeeping Marker for housekeeping tasks and refactorings label Mar 8, 2021
This was referenced Mar 11, 2021
This was referenced Mar 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

housekeeping Marker for housekeeping tasks and refactorings

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants