Hello again I have been reading a bit more about doc strings. And as marcus
said, PEP 257 says that docstrings should be like
def complex(real=0.0, imag=0.0):
"""Form a complex number.
Keyword arguments:
real -- the real part (default 0.0)
imag -- the imaginary part (default 0.0)
"""
if imag == 0.0 and real == 0.0:
return complex_zero
I am trying to convince my self to use this, but it I dont like it.
Why not
def complex(real=0.0, imag=0.0):
"""
Form a complex number.
Description: This script does this and that
and other stuff
Status: work in progress
Extra notes: need to implement something somewhere
Author: some guy
"""
if imag == 0.0 and real == 0.0:
return complex_zero
I don´t want to bore you again with the same questions. I try to follow every
universal convention, I just
don´t understand why in the first line I should begin intermediately after """
and then jump a line, and then the last line alone """
For instance, I do understand how 80 char per lines reads better, and that I
should not create my own style, but this docstring style. I don´t know
R
--
You received this message because you are subscribed to the Google Groups
"Python Programming for Autodesk Maya" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/python_inside_maya/aa15fa0c-0722-4805-8d98-e71816973e73%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
