Update docs

sbslee · Apr 2, 2022 · 8312f58 · 8312f58
1 parent f094e80
commit 8312f58
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 16 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,8 +1,8 @@
 Changelog
 *********
 
-0.32.0 (in development)
------------------------
+0.32.0 (2022-04-02)
+-------------------
 
 * Add new optional argument ``filter_off`` for :class:`pykallisto.KallistoFrame` constructor, which is useful for generating a simple count or tpm matrix.
 * Add new optional argument ``--dir-path`` to :command:`vcf-call` command for storing intermediate files.

diff --git a/docs/cli.rst b/docs/cli.rst
@@ -1275,11 +1275,12 @@ vcf-call
                            within but not across the populations. To use this
                            option, provide a tab-delimited text file with sample
                            names in the first column and group names in the
-                           second column. If '-' is given instead, no HWE
-                           assumption is made at all and single-sample calling
-                           is performed. Note that in low coverage data this
-                           inflates the rate of false positives. Therefore, make
-                           sure you know what you are doing.
+                           second column. If '--group-samples -' is given
+                           instead, no HWE assumption is made at all and
+                           single-sample calling is performed. Note that in low
+                           coverage data this inflates the rate of false
+                           positives. Therefore, make sure you know what you are
+                           doing.
    
    [Example] Specify regions manually:
      $ fuc vcf-call ref.fa 1.bam 2.bam \

diff --git a/fuc/api/pyvcf.py b/fuc/api/pyvcf.py
@@ -262,10 +262,11 @@ def call(
         This option allows to group samples into populations and apply the
         HWE assumption within but not across the populations. To use this
         option, provide a tab-delimited text file with sample names in the
-        first column and group names in the second column. If '-' is given
-        instead, no HWE assumption is made at all and single-sample calling
-        is performed. Note that in low coverage data this inflates the rate
-        of false positives. Therefore, make sure you know what you are doing.
+        first column and group names in the second column. If
+        ``group_samples='-'`` is given instead, no HWE assumption is made at
+        all and single-sample calling is performed. Note that in low coverage
+        data this inflates the rate of false positives. Therefore, make sure
+        you know what you are doing.
 
     Returns
     -------

diff --git a/fuc/cli/vcf_call.py b/fuc/cli/vcf_call.py
@@ -108,11 +108,12 @@ def create_parser(subparsers):
 within but not across the populations. To use this
 option, provide a tab-delimited text file with sample
 names in the first column and group names in the
-second column. If '-' is given instead, no HWE
-assumption is made at all and single-sample calling
-is performed. Note that in low coverage data this
-inflates the rate of false positives. Therefore, make
-sure you know what you are doing."""
+second column. If '--group-samples -' is given
+instead, no HWE assumption is made at all and
+single-sample calling is performed. Note that in low
+coverage data this inflates the rate of false
+positives. Therefore, make sure you know what you are
+doing."""
     )
 
 def main(args):