Skip to content
Snippets Groups Projects
Commit 80334e76 authored by Stephan Seitz's avatar Stephan Seitz
Browse files

Fix some docstrings

parent 34db52d2
No related branches found
No related tags found
No related merge requests found
......@@ -21,11 +21,12 @@ class DiffModes(str, Enum):
def get_jacobian_of_assignments(assignments, diff_variables):
""" Calculates the Jacobian of iterable of assignments wrt. to diff_variables
"""
Calculates the Jacobian of iterable of assignments wrt. diff_variables
Arguments:
assignments {[type]} -- [description]
diff_variables {[type]} -- [description]
assignments (List[pystencils.Assignment]): A collection of assignments or a AssignmentCollection
diff_variables (List[sympy.Symbol]): List of variables used to differentiate
Returns:
sp.Matrix -- Jacobian of statements
......
import pystencils
from pystencils.astnodes import FieldShapeSymbol, FieldStrideSymbol
"""Determines how adjoint fields will be denoted in LaTeX output in terms of the forward field representation %s
Default: r"\hat{%s}" """
"""
Determines how adjoint fields will be denoted in LaTeX output in terms of the forward field representation %s
Default: "\\hat{%s}"
"""
ADJOINT_FIELD_LATEX_HIGHLIGHT = r"\hat{%s}"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment