Skip to main content

DocStrings

Use doc strings when writing scripts for better documentation and to assist auto-complete documentation tooltips. For instance, this example function script:

def func1(parms):
	'''
    Helpful descriptions to help others understand your code.
	Note: will show up in autofill details, so keep it concise.

	Args:
		parms (dict): Small note explaining the param if necessary.

	Returns:
		tuple: Small explanations of the return
		
     '''
     return parms

Will show up in the script editor when using auto-complete like this:

image.png

The following datatypes are supported for arguments and returns:

  • bool
  • int
  • float
  • str
  • tuple
  • list
  • dict
  • any