-
Notifications
You must be signed in to change notification settings - Fork 53
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
Inline code in epytext_demo #567
Comments
Can you provide a example docstring and a screenshot of the rendered content please ? And also whether your using Epytext or restructuredtext. Thanks |
The example is on your server. It is about your epytext_demo. You created the py code and the HTML output. I just read. But here you have a screenshot how this is rendered on Debian 11 with Firefox. |
There is no rendering issue with the demo. If you want to improve the documentation by adding inline markup, please feel free to do so. talk to you later, |
Again you misunderstood me, and maybe also the intention of the Issue. You agree this is a bug in documentation right? It wasn't clear for me. |
No, I don’t think there is a semantical issue in the documentation regarding epytext escaping. Maybe some inline markup could be added to be more explicit. |
pydoctor/docs/epytext_demo/__init__.py
Lines 170 to 172 in 6e2febe
I'm not sure that is why I ask instead of creating an PR. The referenced line appear in the generated HTML documentation not as inline code. But it shouldn't or not?
Current it is: (other than '{' or '}')
It should look like this: (other than
{
or}
)The text was updated successfully, but these errors were encountered: