Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Cadair committed Feb 6, 2025
1 parent c81e2b2 commit 033bf61
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion dkist/dataset/tiled_dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -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``).
Expand Down
2 changes: 1 addition & 1 deletion docs/whatsnew/1.10.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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.
It should be noted that with new metadata ASDF files the indexing of specific tiles will have changed.
Expand Down

0 comments on commit 033bf61

Please sign in to comment.