Repository navigation
Update io.fits docs to reflect memmap=True default #6497
Description
As a spinoff from discussion in #6491, the documentation for io.fits do not make it obvious that the default for memmap is True. The open() docstring just says None (which is more typically the same as False for a bool), and the Getting Started narrative docs don't mention the default True behavior.
Activity
saimn commentedon Aug 31, 2017
Thanks for opening the issue! While looking for other issues I found #4196 which is the same, though the title and description are less clear. I will close the other one.
ayush1999 commentedon Oct 16, 2017
@saimn @taldcroft Is this issue still open?
mkenne15 commentedon Oct 16, 2017
I believe it still is (the docs don't reflect memmap=True by default). I did try to address this, but am only getting started with editing astropy and ran into issues.
ayush1999 commentedon Oct 16, 2017
@mkenne15 Oh. As far I could understand, we need to change the documentation to give the default value of
memmapas true, in io.fits files. What am I missing?mkenne15 commentedon Oct 16, 2017
So that's what I tried, but when I went to recompile astropy with the new documentation it kept failing, and I had no idea why.
saimn commentedon Oct 16, 2017
Yes, it is still open. The goal is really to update the documentation (for instance here, and the
fits.opendocstring), not the default value. This value is obtained from a configuration item; this should also be mentioned in the docs.sushobhana commentedon Jan 14, 2018
hi @taldcroft ..if anyone is not working i would like to fix this.
leahmfulmer commentedon May 1, 2018
This seems like it's closed. Can you confirm, @adrn ?
bsipocz commentedon May 1, 2018
@LFulmer - Sadly the docs still doesn't mention the default. However adding that can be a suitable first time PR if you're interested.
leahmfulmer commentedon May 1, 2018
Yep! I got it.
Resolving Issue astropy#6497
Responding to comments regarding PR on Issue astropy#6497