Skip to content

Commit 3dc0c78

Browse files
Document CLIs
1 parent af4933c commit 3dc0c78

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

bio2zarr/cli.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ def encode(
381381
worker_processes,
382382
):
383383
"""
384-
Convert intermediate columnar format to vcfzarr.
384+
Convert intermediate columnar format to VCF Zarr.
385385
"""
386386
setup_logging(verbose)
387387
check_overwrite_dir(zarr_path, force)
@@ -504,7 +504,7 @@ def convert_vcf(
504504
local_alleles,
505505
):
506506
"""
507-
Convert input VCF(s) directly to vcfzarr (not recommended for large files).
507+
Convert input VCF(s) directly to VCF Zarr (not recommended for large files).
508508
"""
509509
setup_logging(verbose)
510510
check_overwrite_dir(zarr_path, force)
@@ -523,7 +523,7 @@ def convert_vcf(
523523
@click.group(cls=NaturalOrderGroup, name="vcf2zarr")
524524
def vcf2zarr_main():
525525
"""
526-
Convert VCF file(s) to the vcfzarr format.
526+
Convert VCF file(s) to VCF Zarr format.
527527
528528
See the online documentation at https://sgkit-dev.github.io/bio2zarr/
529529
for more information.
@@ -579,6 +579,9 @@ def convert_plink(
579579
@version
580580
@click.group()
581581
def plink2zarr():
582+
"""
583+
Convert plink fileset(s) to VCF Zarr format
584+
"""
582585
pass
583586

584587

@@ -678,6 +681,9 @@ def convert_tskit(
678681
@version
679682
@click.group()
680683
def tskit2zarr():
684+
"""
685+
Convert tskit tree sequence(s) to VCF Zarr format
686+
"""
681687
pass
682688

683689

0 commit comments

Comments
 (0)