[ 
https://issues.apache.org/jira/browse/YETUS-457?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Andrew Wang updated YETUS-457:
------------------------------
    Attachment: YETUS-457.002.patch

Here's a new patch. It demonstrates what I meant about apt escaping, which is 
to say I removed it. It sounds like the special doxia handling referred to in 
the comment is about doxia's markdown implementation, Pegdown, so I elaborated 
on that in the new comment. I also renamed "markdown_sanitize" to 
"sanitize_markdown" and "text_sanitize" to "sanitize_text", which I think makes 
it more clear what the expected input is. I agree on keeping the functions 
split, I misread utils.py originally.

I tried your suggestion of just escaping single quote, but I still see 
rendering issues with not escaping $ when using pandoc. vim's markdown syntax 
highlighting also barfs on [] and other markdown special chars.

Example problem JIRAs:

HADOOP-10134 has "[JDK8]"
YARN-3385 has a "$"

As a human who is currently skimming through these files, I don't find it that 
hard to interpret special characters, partially because they aren't that 
common. It also seems more user-friendly to also support non-Pegdown markdown 
parsers like vim and pandoc as long as it still works in Pegdown.

BTW, is there a way to point Hadoop at a local Yetus checkout? I didn't see 
this process mentioned in the txt files. I think an RDM mode that could take 
some pickled data as input would also be nice for testing, rather than me 
hammering JIRA each time.

> 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, YETUS-457.002.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)

Reply via email to