specutils icon indicating copy to clipboard operation
specutils copied to clipboard

Update docs to recommend use of Spectrum instead of Spectrum1D?

Open kelle opened this issue 9 months ago • 4 comments

I thought that the class name has been "changed" to be Spectrum instead of Spectrum1D but I don't see any evidence of that in the change log. Am I misremembering?

If it has been changed, I suggest we update the docs to use Spectrum instead of Spectrum1D.

kelle avatar Mar 14 '25 17:03 kelle

It's being changed in 2.0, which hasn't been released yet.

rosteen avatar Mar 14 '25 17:03 rosteen

ohhhhh.....gotcha. And I guess there should also be a PR to the APE: https://github.com/astropy/astropy-APEs/blob/main/APE13.rst.

Approximate timeline for release? (I'm writing docs for another package now and want to use Spectrum instead of Spectrum1D.)

kelle avatar Mar 14 '25 17:03 kelle

I was actually hoping to get an RC out by today to facilitate people testing 2.0, but I was still hoping to get @eteq's thumbs up on https://github.com/astropy/specutils/pull/1211. I may just go ahead and merge that (after addressing one minor thing) so I can put out the RC early next week and start addressing any feedback. The goal was to get 2.0 released by the end of the month.

rosteen avatar Mar 14 '25 17:03 rosteen

Exciting!!!

I'm happy to be a reviewer on the updates to the docs when the time comes.

kelle avatar Mar 14 '25 17:03 kelle