Update readme

dockstore · Nov 6, 2024 · 5efa53d · 5efa53d
1 parent e490626
commit 5efa53d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/topicgenerator/README.md b/topicgenerator/README.md
@@ -85,7 +85,12 @@ Usage: <main class> [options] [command] [command options]
             of the entries to upload topics for. The first line of the file 
             should contain the CSV fields: trsId,aiTopic. The output file 
             generated by the generate-topics command can be used as the 
-            argument.
+            argument. Path may be a local path or an S3 URI.
+          -r, --review
+            Whether manual review should be performed before uploading. If 
+            specified, the program will display each topic and ask the user if 
+            it should be uploaded
+            Default: false
 ```
 
 ### generate-topics

diff --git a/...r/src/main/java/io/dockstore/topicgenerator/client/cli/TopicGeneratorCommandLineArgs.java b/...r/src/main/java/io/dockstore/topicgenerator/client/cli/TopicGeneratorCommandLineArgs.java
@@ -88,7 +88,7 @@ public enum ErrorsCsvHeaders {
 
     @Parameters(commandNames = { "upload-topics" }, commandDescription = "Upload AI topics, generated by the generate-topics command, for public Dockstore entries.")
     public static class UploadTopicsCommand {
-        @Parameter(names = {"-ai", "--aiTopics"}, required = true, description = "The file path to the CSV file containing the TRS ID, and AI topics of the entries to upload topics for. The first line of the file should contain the CSV fields: trsId,aiTopic. The output file generated by the generate-topics command can be used as the argument.")
+        @Parameter(names = {"-ai", "--aiTopics"}, required = true, description = "The file path to the CSV file containing the TRS ID, and AI topics of the entries to upload topics for. The first line of the file should contain the CSV fields: trsId,aiTopic. The output file generated by the generate-topics command can be used as the argument. Path may be a local path or an S3 URI.")
         private String aiTopicsCsvFilePath;
 
         @Parameter(names = {"-r", "--review"}, description = "Whether manual review should be performed before uploading. If specified, the program will display each topic and ask the user if it should be uploaded")