excape HTML entities (<>&") in HTML and Markdown output #377
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Otherwise params that use those (esp <>) break the rendering of the HTML output. And because Markdown can contain raw HTML at any place, we escape it there too.
evgeni
commented
Sep 24, 2024
Comment on lines
+14
to
+18
| # $complex_variant:: A Variant type that can be: | ||
| # String with: | ||
| # '' or 'unmanaged' - Host auth control done elsewhere | ||
| # 'ip <List of IPs>' - Allowed IPs/ranges | ||
| # Array of strings with ip or host as above |
There was a problem hiding this comment.
We probably can cut this down to a more artificial doc string.
Currently it very much mimics what's in https://github.com/puppetlabs/puppetlabs-apache/blob/main/manifests/mod/status.pp (and breaking our doc builds)
ekohl
approved these changes
Oct 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Otherwise params that use those (esp <>) break the rendering of the HTML
output. And because Markdown can contain raw HTML at any place, we
escape it there too.