Add documentation to RealGalaxyCatalog.close() #1340
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rmjarvis
added
docs
rmandelb
approved these changes
Dec 9, 2025
Member
rmandelb
left a comment
rmandelb
left a comment
There was a problem hiding this comment.
LGTM. Optional suggestion: I think it could be helpful to have a one-line note in the RealGalaxyCatalog class documentation noting that if memory management is an issue with the various caching steps then the close function could be helpful.
Co-authored-by: Rachel Mandelbaum <rmandelb@andrew.cmu.edu>
Member
Author
|
@rmandelb Good idea. Done. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This mostly just adds a bit of documentation about
RealGalazyCatalog.close, which hadn't been documented. I suspect having it documented would have helped @jecampagne with the problem he reported in #1333.I also changed the implementation very slightly to also clear out the cached noise images, even though they are usually negligible. If people want to release memory manually, I figure we might as well release all of the cached stuff.