From 80334e7698230d54e0762cb5a6ba7333b5de26ba Mon Sep 17 00:00:00 2001
From: Stephan Seitz <stephan.seitz@fau.de>
Date: Wed, 7 Aug 2019 12:12:14 +0200
Subject: [PATCH] Fix some docstrings
---
src/pystencils_autodiff/autodiff.py | 7 ++++---
tests/lbm/adjoint_field.py | 6 ++++--
2 files changed, 8 insertions(+), 5 deletions(-)
diff --git a/src/pystencils_autodiff/autodiff.py b/src/pystencils_autodiff/autodiff.py
index a864db5..984eaaf 100644
--- a/src/pystencils_autodiff/autodiff.py
+++ b/src/pystencils_autodiff/autodiff.py
@@ -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
diff --git a/tests/lbm/adjoint_field.py b/tests/lbm/adjoint_field.py
index 9a598b5..3ac9392 100644
--- a/tests/lbm/adjoint_field.py
+++ b/tests/lbm/adjoint_field.py
@@ -1,8 +1,10 @@
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}"
--
GitLab