From 9d337444276cd7b2367fc313b39e572bfbdd5b28 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sat, 20 May 2017 21:22:43 -0700 Subject: [PATCH] Fix docstring for rotation --- fdfd_tools/operators.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/fdfd_tools/operators.py b/fdfd_tools/operators.py index c7fc578..bfcfcdc 100644 --- a/fdfd_tools/operators.py +++ b/fdfd_tools/operators.py @@ -284,7 +284,8 @@ def m2j(omega: complex, def rotation(axis: int, shape: List[int], shift_distance: int=1) -> sparse.spmatrix: """ - Utility operator for performing a circular shift along a specified axis by 1 element. + Utility operator for performing a circular shift along a specified axis by a + specified number of elements. :param axis: Axis to shift along. x=0, y=1, z=2 :param shape: Shape of the grid being shifted