marcom / ViennaRNA.jl

Julia interface to ViennaRNA for RNA structure prediction and analysis
Other
21 stars 1 forks source link

ViennaRNA C API: docstrings have rendering errors in markdown #18

Open marcom opened 1 year ago

marcom commented 1 year ago

Example:

?ViennaRNA.LibRNA.vrna_plot_coords

The docstring is rendered with Markdown, which breaks the formatting, as the ViennaRNA C library doesn't use markdown, e.g. VRNA_PLOT_TYPE_SIMPLE is rendered as VRNAPLOTTYPE_SIMPLE.

Solution:

When generating the bindings with Clang.jl (in gen/generator.jl), either the docstrings should be surrounded by triple backticks (but backticks would still need to be escaped with a backslash inside the string) or somehow else be made 'markdown-safe'.