Skip to content
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

Fix some GATK doc issues #6318

Merged
merged 2 commits into from Dec 16, 2019
Merged

Fix some GATK doc issues #6318

merged 2 commits into from Dec 16, 2019

Conversation

cmnbroad
Copy link
Collaborator

The current top-level index document has a bogus tool category called "tools" in it (see https://software.broadinstitute.org/gatk/documentation/tooldocs/current/). This is created by the @DocumentedFeature annotation on the AlleleFrequency stratifier class. We don't actually have a category for this, and most are not documented. If at some point we want to add those, we can do so with a real category, but for now this removes the annotation.

There are also some unnatural line breaks in the index, which are removed here. The html doc could use some more maintenance cleanup, but this fixes those two obvious issues.

Copy link
Contributor

@bhanugandham bhanugandham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@cmnbroad cmnbroad merged commit 68d90a2 into master Dec 16, 2019
@cmnbroad cmnbroad deleted the cn_fix_doc branch December 16, 2019 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants