Unclear documentation of FITS_rec
- Dominant language
- Python
- Stars
- 5.3k
- Forks
- 2.2k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 74
Description
At https://github.com/astropy/astropy/blob/master/astropy/io/fits/fitsrec.py#L167
it was said "It inherits all of the standard methods from `numpy.ndarray`".
Could you be more specific which of these methods can be applicable to a FITS_rec object?
As indicated in #4233 , at least the new FITS_rec object do not seem to support 'ndarray.view'.
Since technically FITS_rec is still a subclass of ndarray, please at least mention this strange behavior in the documentation.
On the other hand, if only very few ndarray functions are still valid to FITS_rec, it may be worthwhile consider moving the base class away from ndarray to object.
Thank you!
Contributor guide
Research direction
Read astropy/io/fits/fitsrec.py around line 167 and review issue #4233 first. Identify which inherited numpy.ndarray methods are applicable to FITS_rec, including the reported view behavior, then update the documentation to state the supported behavior and limitations clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100