[
https://issues.apache.org/jira/browse/YETUS-457?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15469073#comment-15469073
]
Allen Wittenauer commented on YETUS-457:
----------------------------------------
Let me be more precise.
The purpose of the sanitize routines is take a format and convert them to
mvn-site safe markdown with as minimal changes as required. The minimal
changes are important because humans may still be skimming through these files.
(Otherwise, we'd just escape the entire symbol set and be done.) They weren't
called _escape intentionally because there is a lot more than just escaping
going on (UTF-8 conversion, cr removal, etc) and it's important that people
don't try to assume that they work just like e.g., html_escape might in any
given programming language's library.
At one point in time, the current routines were one. They were intentionally
split apart to make it easier to understand the code path and make it obvious
what should happen when a 3rd, 4th, etc, format is ever added. There's no real
win here to optimize them back into one when the markdown formatted input needs
very little changing and the raw text one does.
> RDM does not properly escape entities
> -------------------------------------
>
> Key: YETUS-457
> URL: https://issues.apache.org/jira/browse/YETUS-457
> Project: Yetus
> Issue Type: Bug
> Affects Versions: 0.3.0
> Reporter: Andrew Wang
> Assignee: Andrew Wang
> Priority: Critical
> Attachments: YETUS-457.001.patch
>
>
> Noticed while browsing the Hadoop 3.0.0-alpha1 changelog. Quotes and possibly
> some other entities are not escaped properly, leading to malformed markdown
> output.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
