astropy / astropy/specutils

Drop axis option from moment

Open
#930 1 comment 0 reactions 0 assignees View on GitHub
analysis spectral-cube
Dominant language
Python
Stars
204
Forks
134
Avg merge
12h 55m
Merged PRs (30d)
1

Description

@eteq cannot think of a good reason why we need `axis` option in `moment`. Maybe @PatrickOgle knows why. Maybe it should just be hardcoded to -1 (spectral axis).

If we decide to drop it, we need to issue a deprecation warning for a period of time before removing it for good. If we do this, we might also make #925 moot because `order=2, axis=1` will no longer be a valid use case.

https://github.com/astropy/specutils/blob/1651c007f855c87207e9c8548bd0109baa718927/specutils/analysis/moment.py#L31-L33

Contributor guide

Open the contributing guide

Research direction

Start by reading the `axis` option in `specutils/analysis/moment.py` at the linked lines, then review the discussion in this issue and related issue #925. Confirm with maintainers whether `axis` should be deprecated and removed; done means the decision and its effect on the `order=2, axis=1` use case are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.