search

twisted / pydoctor

This is pydoctor, an API documentation generator that works by static analysis.
https://pydoctor.readthedocs.io
Other
186 stars 49 forks source link

Inline code in epytext_demo #567

Open buhtz opened 2 years ago

buhtz commented 2 years ago

https://github.com/twisted/pydoctor/blob/6e2febe63a8ed0f2e316009f34721dc1778661e7/docs/epytext_demo/__init__.py#L170-L172

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 })

tristanlatr commented 2 years ago

Can you provide a example docstring and a screenshot of the rendered content please ? And also whether your using Epytext or restructuredtext.

Thanks

buhtz commented 2 years ago

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

tristanlatr commented 2 years ago

Current it is: (other than '{' or '}') It should look like this: (other than { or })

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,

buhtz commented 2 years ago

Again you misunderstood me, and maybe also the intention of the Issue. I never said this is a rendering issue.

You agree this is a bug in documentation right? It wasn't clear for me.

tristanlatr commented 2 years ago

You agree this is a bug in documentation right?

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.