Pregunta

I have been intrested for python documenting for a while but I can't figured out why @author is default sytnax in python templates. Why it isn't :author: (in restructuredtext style)?

From what reason is used syntax with @ and not with :

I though that restructuredtext is most common in python world.

¿Fue útil?

Solución

The Epytext Markup language is what you're looking for. It is epydoc's language.

It makes use of the @ prefix, with such words as param, type, return, raise, etc.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top