Repository navigation
Update io.fits docs to reflect memmap=True default - #7429
Conversation
|
Hi there @LFulmer 👋 - thanks for the pull request! I'm just a friendly 🤖 that checks for issues related to the changelog and making sure that this pull request is milestoned and labeled correctly. This is mainly intended for the maintainers, so if you are not a maintainer you can ignore this, and a maintainer will let you know if any action is required on your part 😃. Everything looks good from my point of view! 👍 If there are any issues with this message, please report them here. |
| array data of each HDU to be accessed with mmap, rather than being read into | ||
| memory all at once. This is particularly useful for working with very large | ||
| arrays that cannot fit entirely into physical memory. | ||
| arrays that cannot fit entirely into physical memory. Here ``memmap=True`` by defualt, and this value is obtained from a configuration item. |
There was a problem hiding this comment.
typo (defualt). It should also mention the configuration item (astropy.io.fits.Conf.use_memmap).
There was a problem hiding this comment.
I've cancelled the CI given that there'll be a follow-up commit anyway.
|
@LFulmer - Thanks, could you also add this to the |
taldcroft
changed the title
io.fits docs to reflect memmap=True default
|
@LFulmer - I've edited the title for your PR. It is best practice to make the PR title itself descriptive so others can recognize if they should have a look. The reference issue number that is being fixed can just be in the description like you have. |
Update `io.fits` docs to reflect `memmap=True` default
Update `io.fits` docs to reflect `memmap=True` default
Update `io.fits` docs to reflect `memmap=True` default
I've added a sentence to the doc string clarifying that memmap=True by default.
edit: Ref #6497