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

Handle \0 and other characters #2226

Open
mortenpi opened this issue Aug 21, 2023 · 1 comment
Open

Handle \0 and other characters #2226

mortenpi opened this issue Aug 21, 2023 · 1 comment
Labels
Format: HTML Related to the default HTML output Format: LaTeX Related to the LaTeX / PDF output

Comments

@mortenpi
Copy link
Member

If people add explicit \0 characters into docstrings (e.g. https://github.com/tpapp/StataDTAFiles.jl/blob/v0.3.0/src/StataDTAFiles.jl#L103), those get passed on all the way to the writers and we just end up with \0 characters in the generated HTML. We probably don't want that, so we should sanitize the user-provided strings before we output them.

Not entirely sure when we should do it. Obvious option is in HTMLWriter, but maybe it should already be done in the Markdown -> MarkdownAST conversion (open question here: how does CommonMark handle \0-type characters, in the spec and parser?).

Unsure if/how this affects the latex output.

@odow
Copy link
Collaborator

odow commented Nov 1, 2023

Same problem in LaTeX: #1467

@odow odow added Format: LaTeX Related to the LaTeX / PDF output Format: HTML Related to the default HTML output labels Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Format: LaTeX Related to the LaTeX / PDF output
Projects
None yet
Development

No branches or pull requests

2 participants