Update the help docs

ballerina-platform · Mar 20, 2024 · 103a302 · 103a302
1 parent 6e3c414
commit 103a302
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/persist-cli/src/main/resources/cli-help/ballerina-persist-add.help b/persist-cli/src/main/resources/cli-help/ballerina-persist-add.help
@@ -2,8 +2,8 @@ NAME
        bal persist add - Initialize the Ballerina package for persistence.
 
 SYNOPSIS
-       bal persist add [--module]
-                        [--datastore]
+       bal persist add [--module <module name>]
+                        [--datastore <store type>]
                         [<-h> | <--help>]
 
 DESCRIPTION
@@ -12,9 +12,9 @@ DESCRIPTION
          This will also add persist configuration to the Ballerina.toml file.
 
 OPTIONS
-       --module
+       --module <module name>
               The name of the module to initialize the persistence layer. If not specified, the default module will be used.
-       --datastore
+       --datastore <store type>
               The type of the datastore to be used for persistence.
               The supported datastores are 'inmemory', 'mysql', 'mssql', 'postgresql', 'googlesheets' and 'redis'.
               If not specified, the 'inmemory' datastore will be used as the default.

diff --git a/persist-cli/src/main/resources/cli-help/ballerina-persist-generate.help b/persist-cli/src/main/resources/cli-help/ballerina-persist-generate.help
@@ -2,8 +2,8 @@ NAME
        bal persist generate - Generate the client API based on the data model.
 
 SYNOPSIS
-       bal persist generate [--module]
-                            [--datastore]
+       bal persist generate [--module <module name>]
+                            [--datastore <store type>]
                             [<-h> | <--help>]
 
 DESCRIPTION
@@ -12,9 +12,9 @@ DESCRIPTION
        The generated SQL script can be used to create the database tables.
 
 OPTIONS
-       --module
+       --module <module name>
               The name of the module to initialize the persistence layer. If not specified, the default module will be used.
-       --datastore
+       --datastore <store type>
               The type of the datastore to be used for persistence.
               The supported datastores are 'inmemory', 'mysql', 'mssql', 'postgresql', 'googlesheets', and 'redis'.
        -h, --help

diff --git a/persist-cli/src/main/resources/cli-help/ballerina-persist.help b/persist-cli/src/main/resources/cli-help/ballerina-persist.help
@@ -58,7 +58,8 @@ OPTIONS
 BALLERINA COMMANDS
        The below is a list of available subcommands:
 
-       add             Initialize the package for persistence. Used along with `bal build` command.
+       add             Initialize the package for persistence and integrate the client generation to
+                       the `bal build` command.
        init            Initialize the package for persistence for one time code generation. Used along with
                        `generate` command.
        generate        Generate the client API based on the data model defined in the "persist" directory