Skip to content

[vds/docs] Fix erroneous gvcf_batch_size description #14784

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

Merged
merged 1 commit into from
Feb 2, 2025

Conversation

chrisvittal
Copy link
Collaborator

Fixes #14781

Security Assessment

  • This change has no security impact

Impact Description

Docs only

Copy link
Collaborator

@patrick-schultz patrick-schultz left a comment

Choose a reason for hiding this comment

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

Is "pipeline" the right term to use here? I feel like most users would think the entire combiner process was a pipeline. What about "stage"?

I think it's still not clear that branch_factor GVCFs are merged into each VDS. Maybe we could reword the branch_factor description to something like "The number of inputs (VDSs or GVCFs) combined into each intermediate Variant Dataset"?

Also clarify branch_factor description
Copy link
Member

@ehigham ehigham left a comment

Choose a reason for hiding this comment

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

that certainly clears that up

@chrisvittal
Copy link
Collaborator Author

@patrick-schultz can you take another look?

@hail-ci-robot hail-ci-robot merged commit 3026c60 into hail-is:main Feb 2, 2025
2 of 3 checks passed
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.

VDS Combiner code conflicts with documentation
4 participants