DOC: fix docstring
@@ -19,9 +19,10 @@ from ..var import frame_center
def create_fakedisk_cube(fakedisk, angle_list, psf=None, imlib='opencv',
interpolation='lanczos4', cxy=None, nproc=1,
border_mode='constant'):
- """ Rotates an ADI cube to a common north given a vector with the
- corresponding parallactic angles for each frame of the sequence. By default
- bicubic interpolation is used (opencv).
+ """
+ Rotates an ADI cube to a common north given a vector with the corresponding
+ parallactic angles for each frame of the sequence. By default bicubic
+ interpolation is used (opencv).
Parameters
----------
@@ -58,6 +59,8 @@ def create_fakedisk_cube(fakedisk, angle_list, psf=None, imlib='opencv',
Notes
-----
+ .. code-block:: python
+
import numpy as np
fakedisk = np.zeros((200,200))
@@ -66,6 +69,7 @@ def create_fakedisk_cube(fakedisk, angle_list, psf=None, imlib='opencv',
c = create_fakedisk_cube(fakedisk, angle_list, psf=None, imlib='opencv',
interpolation='lanczos4',cxy=None, nproc=1,
border_mode='constant')
+
"""
if not fakedisk.ndim == 2:
raise TypeError('Fakedisk is not a frame or a 2d array.')
