docstring format
|
View:
New views
2 Messages
—
Rating Filter:
Alert me
|
 |
docstring format
by Brian Matherly
::
Rate this Message:
Benny (or whomever),
I've noticed inconsistent docstring formats. Some use epydoc format, some use sphinx format. The coding guidelines require epydoc format: http://www.gramps-project.org/wiki/index.php?title=Programming_Guidelines#Docstrings But the current documentation appears to be created with sphinx: http://www.gramps-project.org/docs/ Which is the official format? If we have switched to sphinx, then the web site should be updated accordingly. ~Brian ------------------------------------------------------------------------------ Come build with us! The BlackBerry(R) Developer Conference in SF, CA is the only developer event you need to attend this year. Jumpstart your developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9 - 12, 2009. Register now! http://p.sf.net/sfu/devconference _______________________________________________ Gramps-devel mailing list Gramps-devel@... https://lists.sourceforge.net/lists/listinfo/gramps-devel |
|
|
Re: docstring format
by Benny Malengier
::
Rate this Message:
2009/11/3 Brian Matherly <brian@...>:
> Benny (or whomever), > > I've noticed inconsistent docstring formats. Some use epydoc format, some use sphinx format. > > The coding guidelines require epydoc format: > http://www.gramps-project.org/wiki/index.php?title=Programming_Guidelines#Docstrings > > But the current documentation appears to be created with sphinx: > http://www.gramps-project.org/docs/ > > Which is the official format? If we have switched to sphinx, then the web site should be updated accordingly. Yes, I am changing things to restructuredtext as format, so as to use sphinx. It is possible to run epydoc on that too I think. Much old modules that have documentation are still in epydoc, but then, they are not included in the generated material at the moment, which is in trunk/docs directory. I'll change the wiki text. Benny > ~Brian > > ------------------------------------------------------------------------------ > Come build with us! The BlackBerry(R) Developer Conference in SF, CA > is the only developer event you need to attend this year. Jumpstart your > developing skills, take BlackBerry mobile applications to market and stay > ahead of the curve. Join us from November 9 - 12, 2009. Register now! > http://p.sf.net/sfu/devconference > _______________________________________________ > Gramps-devel mailing list > Gramps-devel@... > https://lists.sourceforge.net/lists/listinfo/gramps-devel > ------------------------------------------------------------------------------ Come build with us! The BlackBerry(R) Developer Conference in SF, CA is the only developer event you need to attend this year. Jumpstart your developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9 - 12, 2009. Register now! http://p.sf.net/sfu/devconference _______________________________________________ Gramps-devel mailing list Gramps-devel@... https://lists.sourceforge.net/lists/listinfo/gramps-devel |
| Free embeddable forum powered by Nabble | Forum Help |
