Search
 
SCRIPT & CODE EXAMPLE
 
CODE EXAMPLE FOR PYTHON

numpy style docstrings

Docstring Standard
A documentation string (docstring) is a string that describes a module, function, class, or method definition. The docstring is a special attribute of the object (object.__doc__) and, for consistency, is surrounded by triple double quotes, i.e.:

"""This is the form of a docstring.

It can be spread over several lines.

"""
 
PREVIOUS NEXT
Tagged: #numpy #style #docstrings
ADD COMMENT
Topic
Name
1+3 =