Skip to content

Commit 639ef9f

Browse files
author
Eric Culbertson
committed
format documentation
Signed-off-by: Eric Culbertson <[email protected]>
1 parent d01be00 commit 639ef9f

File tree

1 file changed

+13
-5
lines changed
  • pyrasterframes/src/main/python/pyrasterframes

1 file changed

+13
-5
lines changed

pyrasterframes/src/main/python/pyrasterframes/rf_types.py

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -366,11 +366,19 @@ def _repr_png_(self):
366366
def show(self, lower_percentile=1, upper_percentile=99, axis=None, **imshow_args):
367367
"""
368368
Display an image of the tile
369-
:param lower_percentile: between 0 and 100 inclusive. Specifies to clip values below this percentile
370-
:param upper_percentile: between 0 and 100 inclusive. Specifies to clip values above this percentile
371-
:param axis: MatPlotLib axis object to plot onto. Creates new axis if None
372-
:param imshow_args: parameters to pass into matplotlib.pyplot.imshow
373-
:return created or modified axis object
369+
370+
Parameters
371+
----------
372+
lower_percentile: between 0 and 100 inclusive.
373+
Specifies to clip values below this percentile
374+
upper_percentile: between 0 and 100 inclusive.
375+
Specifies to clip values above this percentile
376+
axis : matplotlib axis object to plot onto. Creates new axis if None
377+
imshow_args : parameters to pass into matplotlib.pyplot.imshow
378+
see https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.pyplot.imshow.html
379+
Returns
380+
-------
381+
created or modified axis object
374382
"""
375383

376384
if axis is None:

0 commit comments

Comments
 (0)