docstring convention used in dxf2gcode?

[zappa...@gmail.com]

I noted that function comments use python's docstring convention (""").

But at the same time it uses doxygen-like @param keywords, which doxygen doesn't support in Python mode (doxygen tells to use ## comments before function declaration).

Is some documentation building tool actually used, or that's just "syntax sugar" for documenting functions?

If its just syntax sugar, maybe we should use Python docstring convention?  Something like this (help(str.swapcase)):

|  swapcase(...)
|      S.swapcase() -> string
|
|      Return a copy of the string S with uppercase characters
|      converted to lowercase and vice versa.

Nothing special, but better than seeing those @param's as-is.

[Christian Kohlöffel]

Hi,

 

initial we planed to use epydoc do generate the package documentation. However,  since min. 5 years the epydoc package is not further developed. So I would propose to make new comments according to a newer, more common tool, whatever you prefer. I do not have any preference or experience about newer Tools. So feel free to propose something.

Very helpful would be if there would be a function which converts existing documentation syntax to the newer one.

 

Regards

Christian

--
--
You received this message because you subscribed to the Google
Groups-group "dxf2gcode-dev".
To post a message, send mail to dxf2gc...@googlegroups.com
To unsubscribe, send mail to dxf2gcode-de...@googlegroups.com
See http://groups.google.de/group/dxf2gcode-dev?hl=en for more options
and the dxf2gcode project page at http://code.google.com/p/dxf2gcode/
---
You received this message because you are subscribed to the Google Groups "dxf2gcode-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dxf2gcode-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/dxf2gcode-dev/24289040-0884-4f99-a17e-ccaca4439569%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

 

[Christian Kohlöffel]

I think i found a tool doing what i think of:

https://github.com/dadadel/pyment

[zappa...@gmail.com]

I tried pyment and it seems to work fine with the current @param etc, converting them to reST.

Let's keep this in mind for future, but let's not do it now, otherwise my work on Operations will be very hard to merge o_O

When repository achieves a clean state and no complex branches are in works, we can set up a couple of directories for building the docs for users and developers.

P.S. Could you please take a look at this patch: https://sourceforge.net/p/dxf2gcode/sourcecode/merge-requests/18/

The current 'develop' branch will generate broken G-Code without it.

To unsubscribe, send mail to dxf2gc...@googlegroups.com

See http://groups.google.de/group/dxf2gcode-dev?hl=en for more options
and the dxf2gcode project page at http://code.google.com/p/dxf2gcode/
---
You received this message because you are subscribed to the Google Groups "dxf2gcode-dev" group.

To unsubscribe from this group and stop receiving emails from it, send an email to dxf2gc...@googlegroups.com.