You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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'.
The text was updated successfully, but these errors were encountered:
marcom
changed the title
ViennaRNA C binding docstrings are erroneously rendered with markdown
ViennaRNA C binding docstrings are erroneously rendered
Jun 26, 2023
marcom
changed the title
ViennaRNA C binding docstrings are erroneously rendered
ViennaRNA C API: binding docstrings are erroneously rendered
Jun 26, 2023
marcom
changed the title
ViennaRNA C API: binding docstrings are erroneously rendered
ViennaRNA C API: docstrings are erroneously rendered
Jun 26, 2023
marcom
changed the title
ViennaRNA C API: docstrings are erroneously rendered
ViennaRNA C API: docstrings are rendered as markdown when they are not
Jun 26, 2023
marcom
changed the title
ViennaRNA C API: docstrings are rendered as markdown when they are not
ViennaRNA C API: docstrings have rendering errors in markdown
Jun 26, 2023
Example:
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 asVRNAPLOTTYPE_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'.The text was updated successfully, but these errors were encountered: