Minimal documentation

Author: kureuil

app/routes/crate/version.js

@@ -108,6 +108,8 @@ export default Route.extend({
                             method: 'GET',
                             dataType: 'html',
                             headers: {
+                                // We need to force the Accept header, otherwise crates.io won't return
+                                // the readme file when not using S3.
                                 Accept: '*/*',
                             },
                         }))

src/render.rs

@@ -4,6 +4,8 @@ use pulldown_cmark::html;
 
 use util::CargoResult;
 
+/// Renders a markdown text to sanitized HTML. The returned text should not contain any harmful
+/// HTML tag or attribute (such as iframe, onclick, onmouseover, etc.).
 pub fn markdown_to_html(text: &str) -> CargoResult<String> {
     let mut rendered = String::with_capacity(text.len() * 3 / 2);
     let cleaner = Ammonia {