Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
marcom opened this issue Jun 26, 2023 · 0 comments
Open

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

marcom opened this issue Jun 26, 2023 · 0 comments

Comments

@marcom
Copy link
Owner

marcom commented Jun 26, 2023

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'.

@marcom marcom changed the title ViennaRNA C binding docstrings are erroneously rendered with markdown ViennaRNA C binding docstrings are erroneously rendered Jun 26, 2023
@marcom marcom changed the title ViennaRNA C binding docstrings are erroneously rendered ViennaRNA C API: binding docstrings are erroneously rendered Jun 26, 2023
@marcom marcom changed the title ViennaRNA C API: binding docstrings are erroneously rendered ViennaRNA C API: docstrings are erroneously rendered Jun 26, 2023
@marcom 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 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant