search

datacamp / rdocumentation-app

The web application running rdocumentation.org.
https://www.rdocumentation.org
MIT License
42 stars 13 forks source link

Angle brackets in DESCRIPTION #267

Closed krlmlr closed 7 years ago

krlmlr commented 7 years ago

are missing, see https://www.rdocumentation.org/packages/plogr/versions/0.1-1?, just before "in your C++ modules". Correct text:

A simple header-only logging library for C++. Add 'LinkingTo: plogr' to 'DESCRIPTION', and '#include <plogr.h>' in your C++ modules to use it.

ludov04 commented 7 years ago

Thanks for raising this issue. Seems like a problem at parsing time, we'll look into it

filipsch commented 7 years ago

@ludov04 i checked, not a problem at parsing time, as you can see from the json that the parser produced. The angle brackets are mistaken for html during rendering. Maybe we have to explicitly escape this when parsing the DESCRIPTION file? What do you think?

ludov04 commented 7 years ago

Can the description ever contains html ? If not I can escape it at render time easily

filipsch commented 7 years ago

@ludov04 the description file should never contain HTML no.

ludov04 commented 7 years ago

Then I would escape it when rendering the page

ludov04 commented 7 years ago

fixed now!

krlmlr commented 7 years ago

Thanks!