more description for logunicode #113

LinguaPhylo · Apr 19, 2024 · 2352d6f · 2352d6f
1 parent d71f1f8
commit 2352d6f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/lphybeast/src/main/java/lphybeast/LPhyBeastCMD.java b/lphybeast/src/main/java/lphybeast/LPhyBeastCMD.java
@@ -78,7 +78,10 @@ public class LPhyBeastCMD implements Callable<Integer> {
     @Option(names = {"-seed"}, description = "the seed to run the LPhy script.")
     int seed;
 
-    @Option(names = {"-u", "--logunicode"}, defaultValue = "false", description = "logging as unicode for non-Windows users.")
+    @Option(names = {"-u", "--logunicode"}, defaultValue = "false",
+            description = "whether to log IDs in unicode. " +
+                    "If false as default, the original ID in unicode will be converted to canonical letters, " +
+                    "specially for avoiding the displaying issue in Windows.")
     boolean logunicode;
 
     @Option(names = {"-vf", "--version_file"}, split = ",",

diff --git a/lphybeast/src/main/java/lphybeast/LPhyBeastConfig.java b/lphybeast/src/main/java/lphybeast/LPhyBeastConfig.java
@@ -78,6 +78,8 @@ public LPhyBeastConfig(Path infile, Path outfile, Path wd, String[] lphyConst, S
         this.lphyConst = lphyConst;
         // Ignoring the logging ability for the given lphy random variables
         this.varNotLog = varNotLog;
+        // whether to log IDs in unicode. If false as default,
+        // the original ID in unicode will be converted to canonical letters for Windows users.
         this.logunicode = logunicode;
 
         if (infile == null || !infile.toFile().exists())