Skip to content

Commit 0f130b0

Browse files
committed
improve docstring
1 parent 956068d commit 0f130b0

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

pytential/symbolic/pde/system_utils.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,12 @@ def _monom_to_expr(monom: List[int],
137137

138138

139139
def convert_target_transformation_to_source(int_g: IntG) -> List[IntG]:
140-
"""Convert an ``IntG`` with AxisTargetDerivative/TargetMultiplier to a list
140+
"""Convert an ``IntG`` with :class:`sumpy.kernel.AxisTargetDerivative`
141+
or :class:`sumpy.kernel.TargetMultiplier` to a list
141142
of ``IntG``s without them and only source dependent transformations.
142-
The sum of the list returned is a tranformation of the input ``IntG``.
143+
The sum of the list returned is equivalent to the input *int_g*.
143144
144-
eg::
145+
For example::
145146
146147
IntG(d/dx r, sigma) -> [IntG(d/dy r, -sigma)]
147148
IntG(x*r, sigma) -> [IntG(r, sigma*y), IntG(r*(x -y), sigma)]
@@ -359,8 +360,8 @@ def get_deriv_relation_kernel(kernel: ExpressionKernel,
359360
order *order* and a constant. *tol* is an upper limit for small numbers that
360361
are replaced with zero in the numerical procedure.
361362
362-
Returns the constant and a list of (mulit-index, coeff) to represent the
363-
linear combination of derivatives
363+
:returns: the constant and a list of (multi-index, coeff) to represent the
364+
linear combination of derivatives
364365
"""
365366
kernel_arguments = dict(hashable_kernel_arguments)
366367
(L, U, perm), rand, mis = _get_base_kernel_matrix(base_kernel, order=order,

0 commit comments

Comments
 (0)