Skip to content

Conversation

danielparks
Copy link
Contributor

Sometimes data types, default values, and other code outputted in Markdown documentation is multiline. When that’s the case, it’s cleaner to use a code block (below) rather and inline code (code).

example code block
with two lines

This updates the Markdown template code to use code blocks in many places if the code in question contains a newline.

Thanks to @crazymind1337 for the example of a multiline type alias!

Sometimes data types, default values, and other code outputted in
Markdown documentation is multiline. When that’s the case, it’s cleaner
to use a code block (below) rather and inline code (`code`).

```
example code block
with two lines
```

This updates the Markdown template code to use code blocks in many
places if the code in question contains a newline.

Thanks to @crazymind1337 for the example of a multiline type alias!
@danielparks danielparks requested a review from a team as a code owner September 29, 2022 14:52
@chelnak
Copy link
Contributor

chelnak commented Sep 29, 2022

@danielparks You are on fire 🔥

I'll review this as soon as I can

@danielparks
Copy link
Contributor Author

No hurry!

Copy link
Contributor

@chelnak chelnak left a comment

Choose a reason for hiding this comment

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

💯

@chelnak chelnak merged commit 371e37f into puppetlabs:main Sep 29, 2022
@chelnak chelnak self-assigned this Sep 29, 2022
@danielparks danielparks deleted the multiline_code_blocks branch September 29, 2022 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants