Important Notice: Our web hosting provider recently started charging us for additional visits, which was unexpected. In response, we're seeking donations. Depending on the situation, we may explore different monetization options for our Community and Expert Contributors. It's crucial to provide more returns for their expertise and offer more Expert Validated Answers or AI Validated Answers. Learn more about our hosting issue here.

Why does epydoc render one of my epytext-formatted docstrings as plaintext?

epydoc plaintext render
0
Posted

Why does epydoc render one of my epytext-formatted docstrings as plaintext?

0

Since epytext is used as the default markup language for epydoc, it needs to be very conservative — it will be used to display many docstrings that are not explicitly written using epytext, and it needs to display those docstrings in a readable way. Therefore, whenever epytext encounters a docstring that doesn’t strictly conform to the epytext markup language, it renders it as plaintext. If you expect one of your docstrings to be processed using epytext, but it gets rendered as plaintext, then the docstring most likely contains one or more markup errors. Run epydoc with the -v option to see markup errors, and check for an error in the docstring in question. Once you fix the markup errors, the docstring will be processed as expected.

Related Questions

What is your question?

*Sadly, we had to bring back ads too. Hopefully more targeted.