From 3ccf3b861ae5aa167b3c5eb899ad044c742cdf44 Mon Sep 17 00:00:00 2001 From: Stuart Mumford Date: Thu, 6 Feb 2025 17:02:13 +0000 Subject: [PATCH] doc fixes --- dkist/dataset/tiled_dataset.py | 2 +- docs/whatsnew/1.10.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/dkist/dataset/tiled_dataset.py b/dkist/dataset/tiled_dataset.py index 51e4f540..a82aeeb7 100644 --- a/dkist/dataset/tiled_dataset.py +++ b/dkist/dataset/tiled_dataset.py @@ -196,7 +196,7 @@ def plot(self, slice_index, share_zscale=False, figure=None, swap_tile_limits: L slice_index : `int`, sequence of `int`s or `numpy.s_` Object representing a slice which will reduce each component dataset of the TiledDataset to a 2D image. This is passed to - ``TiledDataset.slice_tiles``, if each tile is already 2D pass ``slice_index=...`. + `.TiledDataset.slice_tiles`, if each tile is already 2D pass ``slice_index=...``. share_zscale : `bool` Determines whether the color scale of the plots should be calculated independently (``False``) or shared across all plots (``True``). diff --git a/docs/whatsnew/1.10.rst b/docs/whatsnew/1.10.rst index bcf15636..2db60999 100644 --- a/docs/whatsnew/1.10.rst +++ b/docs/whatsnew/1.10.rst @@ -11,9 +11,9 @@ This release of ``dkist`` includes compatibility with new metadata ASDF files ge .. warning:: - You should re-download ASDF files when upgrading to this version of ``dkist``, particularly for VBI data. + You should re-download all ASDF files when upgrading to this version of ``dkist``, particularly for VBI data. -These ASDF files change the ordering of the tiles inside a `.TiledDataset` object to correctly account for the differences between column-major (in FITS files) and row-major ordering (in numpy), this release of ``dkist`` updates the `.TiledDataset.plot` method to correctly plot these tiles in the expected order. +These ASDF files change the ordering of the tiles inside a `.TiledDataset` object to correctly account for the differences between column-major (in FITS files) and row-major ordering (in numpy); this release of ``dkist`` updates the `.TiledDataset.plot` method to correctly plot these tiles in the expected order. It should be noted that with new metadata ASDF files the indexing of specific tiles will have changed.