feat: deprecate OkForAsymmetry and Golden, and provide guidance for their replacement
#50
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
this file is meant to be used by: - the local C++ and Groovy classes - documentation generation - an iguana algorithm
... but it still consumes way too much memory... wontfix, since will be deprecated soon
c-dilks
force-pushed
the
deprecation
branch
from
ad8f424 to
924a678
Compare
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.
The QADB has always provided the ability for users to customize which defects they want to accept or reject, whereas
OkForAsymmetryandGoldenare just "preset" choices.OkForAsymmetrywas focused on RG-A and RG-B beam spin analyses only; although it is very convenient, it's not the QADB's job to provide a "one option for all" sort of criteria set. The analyzers should choose their criteriaGoldenmeans "no defect", and with the addition of several new defect bits in feat: RG-C Summer 2022 QADB #49, there may be long periods of time where none of the data areGoldenCalling either of
OkForAsymmetryorGoldenwill now print a deprecation warning, and will provide guidance for the preferred, general QADB usage:OkForAsymmetry, general QADB code for an exact replacement implementation is provided in a simple test program, which demonstrates its equivalence toOkForAsymmetry.Golden, just require no defects, but note that the only QADBs with the "older" set of bits (0-9) are Run Groups A, B, K, and M for Pass 1 dataNeither
OkForAsymmetrynorGoldenwill be removed; however, we plan to add QADB usage as an Iguana algorithm, and these methods will not be provided there.