Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc tweaks #823

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc tweaks #823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc tweaks 
(cherry picked from commit e9e7024)
  • Loading branch information
@nabobalis
nabobalis committed Feb 12, 2025
commit 61e3af9b1684aa6d6b0b4cfefbd9b7c1dd94b2c5
2 changes: 1 addition & 1 deletion CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ New Features
- Added `~ndcube.NDCube.quantity` attribute to `~ndcube.NDCube` to return the data array with in the cube with the physical units stored in the `~ndcube.NDCube.unit` attribute. (`#677 <https://github.com/sunpy/ndcube/pull/677>`__)
- Enable `~ndcube.NDCube` to be raised to a power. (`#678 <https://github.com/sunpy/ndcube/pull/678>`__)
- Added `ndcube.NDCube.shape` as a replacement for "dimensions". (`#684 <https://github.com/sunpy/ndcube/pull/684>`__)
- Enable rtruediv on`~ndcube.NDCube` such that a user can now do 1/`~ndcube.NDCube`. (`#685 <https://github.com/sunpy/ndcube/pull/685>`__)
- Enable rtruediv on `~ndcube.NDCube` such that a user can now do 1/ `~ndcube.NDCube`. (`#685 <https://github.com/sunpy/ndcube/pull/685>`__)
- Add a ``keepdims=False`` kwarg to `~ndcube.NDCube.crop` and `~ndcube.NDCube.crop_by_values` setting to true keeps length-1 dimensions default behavior drops these dimensions. (`#732 <https://github.com/sunpy/ndcube/pull/732>`__)
- When calling :meth:`ndcube.NDCubeBase.axis_world_coords` or :meth:`ndcube.NDCubeBase.axis_world_coords_values` with a
specific axis or axes specified, the methods now avoid doing calculations for any other uncorrelated axes, offering
Expand Down
2 changes: 2 additions & 0 deletions docs/nitpick-exceptions
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ py:class None. Remove all items from D.
py:class a shallow copy of D
py:class v, remove specified key and return the corresponding value.
py:class None. Update D from mapping/iterable E and F.
# Comes from astropy? psf
py:obj ndarray
5 changes: 3 additions & 2 deletions ndcube/ndcube.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,11 +407,12 @@ def __init__(self, data, wcs=None, uncertainty=None, mask=None, meta=None,
@property
def data(self):
"""
`~numpy.ndarray`-like : The stored dataset.
`~numpy.ndarray` - like
The stored dataset.

Notes
-----
It is possible to set the ``.data`` attribute on a `NDCube` with an
It is possible to set the ``.data`` attribute on a `~ndcube.NDCube` with an
array-like object of the same shape. However, this is really only
intended for replacing the data with a different object representing
the same physical data as no other properties of the cube will be
Expand Down