Skip to content

Commit

Permalink
Fix save/export_image API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sitic committed Oct 11, 2024
1 parent 33383d0 commit bd0fa36
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions optimap/image/_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ def save_mask(filename, mask, image=None, **kwargs):


def save_image(filename, image: np.ndarray, compat=False, **kwargs):
"""Save an image to a file. Makes best effort to avoid data precision loss, use {func}`export_image` to export images for publications.
"""Save an image to a file. Makes best effort to avoid data precision loss, use :func:`export_image` to export images for publications.
The image data is saved as it is, without any normalization or scaling.
Expand Down Expand Up @@ -257,7 +257,7 @@ def export_image(filename,
cmap = "gray",
vmin : float = None,
vmax : float = None):
"""Export an image to a file for publications, use {func}`save_image` to save an image if it will be reimported later.
"""Export an image to a file for publications, use :func:`save_image` to save an image if it will be reimported later.
Images will be converted to uint8, colormap will be applied to grayscale images.
Expand Down

0 comments on commit bd0fa36

Please sign in to comment.