-
Notifications
You must be signed in to change notification settings - Fork 17
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
investigate tree-sitter rst handling of trailing letters after backticks. #275
Comments
I think that affect for example:
|
The SciPy examples are both wrong. You can see in the online docs that they don't render correctly https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.bootstrap.html https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.geninvgauss.html. Unfortunately, it seems these do not actually produce any warnings from Sphinx/docutils. If tree-sitter-rst actually does give warnings here that's a nice feature. The RST spec is very specific about what is allowed here:
Everything else must be escaped with a backslash Of course, I have no idea if tree-sitter-rst actually follows all these rules, but the examples given here don't show any issues with it. I would suggest closing this PR and submitting upstream fixes to libraries like scipy to fix their RST formatting. |
Thanks for looking at the SciPy docs, it's indeed improperly render. Let's keep this open in case we found other case, but let's try to send patches upstream to fix the SciPy docs, so we don't have errors. |
I think there might be some case where tree-sitter-rst does
I have to recheck. |
I believe that tree sitter rst parse
a few `object`s
differently than docutils, I think that raises warning in building some of the docs.The text was updated successfully, but these errors were encountered: