Commit 9b85909a authored by Theo Steininger's avatar Theo Steininger
Browse files

Docstring cosmetics in RGSpace

parent 25495b60
Pipeline #12221 passed with stages
in 11 minutes and 4 seconds
......@@ -74,15 +74,14 @@ class RGSpace(Space):
zerocenter : {bool, numpy.ndarray}, *optional*
Whether the Fourier zero-mode is located in the center of the
grid (or the center of each axis speparately) or not
MR FIXME: this also does something if the space is not harmonic!
(default: False).
distances : {float, numpy.ndarray}, *optional*
Distance between two grid points along each axis
(default: None).
If distances==None:
if harmonic==True, all distances will be set to 1
if harmonic==False, the distance along each axis will be
set to the inverse of the number of points along that axis
set to the inverse of the number of points along that
axis.
harmonic : bool, *optional*
Whether the space represents a Fourier or a position grid
(default: False).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment