-1

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.

Karlvonbahnhof
  • 94
  • 10
  • Is this question about the markup language used, or specifically the `@author` directive? – shx2 Dec 01 '13 at 20:56
  • I edited the question. Maybe is more specific now. It is wierd to me that restructuredtext is most common but in template is used another style. I'm afraid I miss some important tool. – Karlvonbahnhof Dec 01 '13 at 21:06

1 Answers1

2

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.

shx2
  • 61,779
  • 13
  • 130
  • 153
  • And epytext is so common that pydev has it like default template? And could it be something about svn or something? – Karlvonbahnhof Dec 01 '13 at 20:58
  • Can you be more specific? what are you trying to achieve? What do you mean by "could it be"...? – shx2 Dec 01 '13 at 20:59
  • I thought that maybe svn uses this attributes but it's probably nonsens. – Karlvonbahnhof Dec 01 '13 at 21:07
  • 1
    @Karlvonbahnhof you need to take a look on history - PyDev is older project than Sphinx and the documentation of Python code has been mixed bag before Sphinx kind of standardized it. Default Sphinx templates would make sense today. Fabio is great guy and surely accepts contributions to PyDev ;) – Mikko Ohtamaa Dec 02 '13 at 22:44
  • Thank you. This is the answer that I ecpected. – Karlvonbahnhof Dec 03 '13 at 14:01