Skip to content

Commit

Permalink
Escape HTML entities in doc comments (#10252)
Browse files Browse the repository at this point in the history
* Escape HTML entities in doc comments

* Put a HTML entity out of backticks
because then at least typical Markdown parsers agree with Crystal's parser.
  • Loading branch information
oprypin authored Jan 18, 2021
1 parent ef93a80 commit f029f5e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/html.cr
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ module HTML
}

# Returns a string where named and numeric character references
# (e.g. >, >, &x3e;) in *string* are replaced with the corresponding
# (e.g. >, >, >) in *string* are replaced with the corresponding
# unicode characters. This method decodes all HTML5 entities including those
# without a trailing semicolon (such as `&copy`).
# without a trailing semicolon (such as "&copy").
#
# ```
# require "html"
Expand Down

0 comments on commit f029f5e

Please sign in to comment.