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

Inline code in epytext_demo #567

Open
buhtz opened this issue May 8, 2022 · 5 comments
Open

Inline code in epytext_demo #567

buhtz opened this issue May 8, 2022 · 5 comments

Comments

@buhtz
Copy link
Contributor

buhtz commented May 8, 2022

If the escape code is a single character (other than '{' or '}'), then that character is produced.
For example, to begin a paragraph with a dash (which would normally signal a list item), write 'E{-}'.
In addition, two special escape codes are defined: 'E{lb}' produces a left curly brace ('{'); and 'E{rb}' produces a right curly brace ('}').

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
Copy link
Contributor

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

Thanks

@buhtz
Copy link
Contributor Author

buhtz commented May 8, 2022

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
Copy link
Contributor

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
Copy link
Contributor Author

buhtz commented May 8, 2022

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
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants