← Back to team overview

ufl team mailing list archive

Docstrings

 

Should we use epydoc in UFL? Then we can generate a nice hyperlinked
reference documentation.

Example:

def inverse(A):
    """The inverse of A.

    @type A: UFLObject
    @param A: Nonsingular rank 2 tensor (matrix).
    @rtype: UFLObject
    @return: The matrix that is the inverse of A.
    """
    ...

-- 
Martin


Follow ups