Are you meaning the style guide for docstrings? Like this thing?
https://www.python.org/dev/peps/pep-0257/

Other than that, I figure it has also somewhat to do with what
documentation generator you may be using. If you play to use Sphinx to
generate documentation from your source code, then you may choose to use
either the restructedText <http://www.sphinx-doc.org/en/stable/rest.html>
format or the Google napolean
<http://www.sphinx-doc.org/en/stable/ext/example_google.html> format

But as far as pep8 is concerned, you should probably break those long lines
up in your actual source code ;-)

Also, I don't know if there is any particular standard on using the short
or long flag names. It is really your choice to do what you think is most
readable. Maybe if you use a lot of those more obscure flags, then it might
be good to be able to read the long form. But that is purely a suggestion



On Mon, Jul 11, 2016 at 5:00 PM yann19 <[email protected]> wrote:

> Oh and adding on one more questions - is it more common to write the full
> name of the flags or the short names of the flags?
> Eg. cmds.camera(q=True) or cmds.camera(query=True)
>
> --
> 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/98e1fd5c-1591-4736-b4f1-ac0725cdb4c8%40googlegroups.com
> <https://groups.google.com/d/msgid/python_inside_maya/98e1fd5c-1591-4736-b4f1-ac0725cdb4c8%40googlegroups.com?utm_medium=email&utm_source=footer>
> .
> For more options, visit https://groups.google.com/d/optout.
>

-- 
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/CAPGFgA19ToCr%3DkE42hi4sMLJQEgP2UDxBUb%3Dyd46uHa_tebwZA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to