Skip to content

Invalid syntax in docs xml #837

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

Closed
andreymal opened this issue Aug 3, 2024 · 1 comment · Fixed by #861
Closed

Invalid syntax in docs xml #837

andreymal opened this issue Aug 3, 2024 · 1 comment · Fixed by #861
Labels
bug c: register Register classes, functions and other symbols to GDScript

Comments

@andreymal
Copy link
Contributor

I literally copied godot/tests/docs.rs into a new project and got this:

Same happens with code blocks like these:

/// some html snippets inside docstring:
///
/// `foo <em>bar</em>`
///
/// ```html
/// foo <u>bar</u>
/// ```

Replacing < with &amp;lt; (double escaping because markdown unescapes one) fixes everything.

So I suspect that doc strings must be escaped somewhere?

@Bromeon Bromeon added bug c: register Register classes, functions and other symbols to GDScript labels Aug 4, 2024
@Bromeon
Copy link
Member

Bromeon commented Aug 4, 2024

Thanks for pointing these out! Doc registration is a very recent feature (#748), so some parts are not yet ironed out.

Would you be interested in submitting a pull request to address some of the points you mentioned? Someone else recently made a similar PR #815, which could serve as inspiration. We can of course gladly assist and guide you in case of questions! 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug c: register Register classes, functions and other symbols to GDScript
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants