DM-24664: Refactor data ID translation rule system #146
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
parejkoj
reviewed
May 1, 2020
| @@ -87,3 +88,17 @@ def getRawFormatter(self, dataId): | |||
| # local import to prevent circular dependency | |||
| from .rawFormatter import DarkEnergyCameraRawFormatter | |||
| return DarkEnergyCameraRawFormatter | |||
|
|
|||
| def makeDataIdTranslatorFactory(self) -> TranslatorFactory: | |||
| # Docstring inherited from lsst.obs.base.Instrument. | |||
There was a problem hiding this comment.
I've been ambivalent about these comments since I started seeing them in daf_butler. They seem to mostly add clutter, and provide benefit mostly for the reviewer.
There was a problem hiding this comment.
I don't love them either, but don't have an alternative that I like a lot better - the best alternative us all to start assuming that if a method is undocumented on a class with a base class, the docstring is inherited, but I don't really feel our docs are in sufficiently good shape for that to be a reasonable assumption most of the time.
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.
No description provided.