-
Notifications
You must be signed in to change notification settings - Fork 597
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add DeprecatedFeature annotation. #8100
Conversation
Github actions tests reported job failures from actions build 3527272492
|
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #8100 +/- ##
===============================================
+ Coverage 84.069% 86.604% +2.535%
- Complexity 37456 38940 +1484
===============================================
Files 2335 2335
Lines 182679 182680 +1
Branches 20052 20052
===============================================
+ Hits 153577 158209 +4632
+ Misses 22059 17433 -4626
+ Partials 7043 7038 -5
|
a428cff
to
8940fae
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cmnbroad Minor comments.
It might be nice to replace the (Deprecated)
mark in the html with something more like the little bubbles for the input type so it stands out a bit more. (even if it's in its own dedicated section.)
@@ -32,7 +33,7 @@ public class HaplotypeCallerReadThreadingAssemblerArgumentCollection extends Rea | |||
/** | |||
* As of version 3.3, this argument is no longer needed because dangling end recovery is now the default behavior. See GATK 3.3 release notes for more details. | |||
*/ | |||
@Deprecated | |||
@DeprecatedFeature |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This has been deprecated since 3.3... maybe we can remove it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we put the reason in the description?
@@ -115,7 +116,7 @@ public ReadThreadingAssembler createReadThreadingAssembler(){ | |||
public File f1r2TarGz; | |||
|
|||
// As of GATK 4.1, any sample not specified as the normal is considered a tumor sample | |||
@Deprecated | |||
@DeprecatedFeature |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we move the reason into here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. Done.
@@ -61,7 +62,7 @@ public GenotypeCalculationArgumentCollection clone() { | |||
/** | |||
* As of version 4.1.0.0, this argument is no longer needed because the new qual score is now on by default. See GATK 3.3 release notes for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does javadoc on arguments get output in our docs at all?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it gets included in the full text description.
8940fae
to
fa51f93
Compare
@cmnbroad Are we waiting on something to merge this? 👍 from me. |
fa51f93
to
d8d7f27
Compare
Upgrades Barclay to 4.1.0. Adds an
@DeprecatedFeature
annotation that can be applied to any@DocumentedFeature
or@Argument
, and updates the handful of such features that are already tagged with the standard Java annotation@Deprecated
to use the new annotation. Mutually exclusive with@Beta
and@Experimental
.The output for
--use-new-qual-calculator
: