Rename DetectorArray ➡️ DetectorManager plus Docstrings and Refactoring
#423
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #423 +/- ##
=======================================
Coverage 75.32% 75.32%
=======================================
Files 56 56
Lines 7810 7823 +13
=======================================
+ Hits 5883 5893 +10
- Misses 1927 1930 +3 ☔ View full report in Codecov by Sentry. |
teutoburg
changed the title
DetectorArray ➡️ DetectorManager plus Docstrings and Refactoring
teutoburg
force-pushed
the
fh/detectorcleanup
branch
from
f614413
to
8508722
Compare
Also in all corresponding file names. Also in variable names like detector_arrays -> detector_managers Rationale: I always found the existance of both DetectorList and DetectorArray quite confusing. The now-renamed class acts in a somewhat comparable way to the FOVManager or OpticsManager, thus I found it fitting to apply this naming convention also to this class. There are two occurences in IRDB package tests where this change will need to be incorporated to avoid breaking those tests. Also, some refactoring Make functions and attribute private that are not currently used outside the class anyway.
teutoburg
force-pushed
the
fh/detectorcleanup
branch
from
8508722
to
8c18271
Compare
hugobuddel
approved these changes
Jun 28, 2024
Co-authored-by: Hugo Buddelmeijer <hugo@buddelmeijer.nl>
Hmm, perhaps not a bad idea. I'll include that if it doesn't break anything (which would surprise me but I've been surprised many times by this codebase). |
Had to catch the case where detector_list isn't passed, which happens in testing. Figured a warning wouldn't hurt, as this case shouldn't occur in regular operation.
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.
Rename class
DetectorArray➡️DetectorManagerand all corresponding file names.Also rename variable names like
detector_arrays➡️detector_managersand react to changes in test modules.Rationale
I always found the existence of both
DetectorListandDetectorArrayquite confusing. The now-renamed class acts in a somewhat comparable way to theFOVManagerandOpticsManagerclasses, thus I found it fitting to apply this naming convention also to this class.This was done after brief discussion with @astronomyk a few weeks ago, now rebased and finalized.
Consequences
There are two occurrences in IRDB package tests where this change will need to be incorporated to avoid breaking those tests. Other than that, the things changed here are rather internal, so unlikely to break any existing scripts.
Other Changes along the Way
Version Change?
This (and other things coming soon) might be considered worth of a minor version bump (aka v0.9.0).