Skip to content

Commit

Permalink
Finish off docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
e-koch committed Nov 11, 2020
1 parent 648d87f commit 83f1a36
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions spectral_cube/spectral_cube.py
Original file line number Diff line number Diff line change
Expand Up @@ -817,11 +817,14 @@ def argmax_world(self, axis, **kwargs):
'''
Return the spatial or spectral index of the maximum value
along a line of sight.
Parameters
----------
axis : int
The axis to return the peak location along. e.g., `axis=0`
will return the value of the spectral axis at the peak value.
kwargs : dict
Passed to `~SpectralCube.argmax`.
'''

argmax_plane = self.argmax(axis=axis, **kwargs)
Expand Down Expand Up @@ -852,6 +855,8 @@ def argmin_world(self, axis, **kwargs):
axis : int
The axis to return the peak location along. e.g., `axis=0`
will return the value of the spectral axis at the peak value.
kwargs : dict
Passed to `~SpectralCube.argmax`.
'''

argmin_plane = self.argmin(axis=axis, **kwargs)
Expand Down

0 comments on commit 83f1a36

Please sign in to comment.