Markdown for package's description?

[Kakadu]

It seems some packages don't use wiki syntax in the descr file and the output in the web interface is messy.

I'm not sure is it regulated (documentation seems a little bit messy (#10) (no offense) or maybe I didn't read long enough through doc). Maybe we should force plain text there or add some opam lint check about this? I'm sorry if that is not the right place and I should open an issue in the opam-repository.

[XVilka]

@rjbou It's still a problem, e.g. see https://opam.ocaml.org/packages/radare2/

This is what I have in the opam file:

description: """
Interact with radare2,
See the mli for documentation, example usage in utop:

#require "radare2";;
let result = R2.with_command_j ~cmd:"/j COLUMNS" "/bin/ls";;
val result : Yojson.Basic.t =
`List
  [`Assoc
     [("offset", `Int 109075); ("type", `String "string");
      ("data", `String "eQUOTING_STYLECOLUMNSTABSIZEinvalid")];
   `Assoc
     [("offset", `Int 118247); ("type", `String "string");
      ("data", `String "onment variable COLUMNS: %signori")]]\""""

At the same time, if I try to escape backticks or hash symbols, the opam fails itself, e.g. on:

description: """
Interact with radare2,
See the mli for documentation, example usage in utop:

\#require "radare2";;
let result = R2.with_command_j ~cmd:"/j COLUMNS" "/bin/ls";;
val result : Yojson.Basic.t =
\`List
  [\`Assoc
     [("offset", \`Int 109075); ("type", \`String "string");
      ("data", \`String "eQUOTING_STYLECOLUMNSTABSIZEinvalid")];
   \`Assoc
     [("offset", \`Int 118247); ("type", \`String "string");
      ("data", \`String "onment variable COLUMNS: %signori")]]\""""

See the error:

error 2: File format error at line 55, column 1: illegal escape sequence