Sounds like a typical usecase for docstring along with line comment.

def my_function():
  """Short description of function

  Longer description, with argument signature and return type etc
  related to the function overall.

  """

  # Line comment, related to upcoming line or series of lines.
  code here

This, along with “cyclomatic complexity
<https://en.wikipedia.org/wiki/Cyclomatic_complexity>“, in particular about
keeping functions small, should encourage short and concise code.
​
Was this what you meant?
​

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

Reply via email to