Updates for reviewer feedback

Start9Labs · Oct 15, 2024 · 635d9f6 · 635d9f6
1 parent fcdc2e0
commit 635d9f6
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 9 deletions.
diff --git a/core/startos/src/auth.rs b/core/startos/src/auth.rs
@@ -107,7 +107,7 @@ pub fn auth<C: Context>() -> ParentHandler<C> {
         )
         .subcommand(
             "session",
-            session::<C>().with_about("List or Kill StartOS sessions"),
+            session::<C>().with_about("List or kill StartOS sessions"),
         )
         .subcommand(
             "reset-password",

diff --git a/core/startos/src/db/mod.rs b/core/startos/src/db/mod.rs
@@ -35,7 +35,7 @@ pub fn db<C: Context>() -> ParentHandler<C> {
             "dump",
             from_fn_async(cli_dump)
                 .with_display_serializable()
-                .with_about("Return db tables and records"),
+                .with_about("Filter/query db to display tables and records"),
         )
         .subcommand("dump", from_fn_async(dump).no_cli())
         .subcommand(
@@ -312,7 +312,7 @@ pub fn put<C: Context>() -> ParentHandler<C> {
         "ui",
         from_fn_async(ui)
             .with_display_serializable()
-            .with_about("Store pointer and value in db")
+            .with_about("Add path and value to db")
             .with_call_remote::<CliContext>(),
     )
 }

diff --git a/core/startos/src/lib.rs b/core/startos/src/lib.rs
@@ -149,7 +149,7 @@ pub fn main_api<C: Context>() -> ParentHandler<C> {
         .subcommand(
             "auth",
             auth::auth::<C>().with_about(
-                "Commands related to Authentication such as logging in, resetting password, etc",
+                "Commands related to Authentication i.e. login, logout, reset-password",
             ),
         )
         .subcommand(
@@ -158,11 +158,13 @@ pub fn main_api<C: Context>() -> ParentHandler<C> {
         )
         .subcommand(
             "ssh",
-            ssh::ssh::<C>().with_about("Add, delete, or list ssh keys"),
+            ssh::ssh::<C>()
+                .with_about("Commands for interacting with ssh keys i.e. add, delete, list"),
         )
         .subcommand(
             "wifi",
-            net::wifi::wifi::<C>().with_about("Commands related to wifi networks"),
+            net::wifi::wifi::<C>()
+                .with_about("Commands related to wifi networks i.e. add, connect, delete"),
         )
         .subcommand(
             "disk",
@@ -447,7 +449,7 @@ pub fn diagnostic_api() -> ParentHandler<DiagnosticContext> {
         .subcommand(
             "diagnostic",
             diagnostic::diagnostic::<DiagnosticContext>()
-                .with_about("Commands to display logs, restart the server, etc"),
+                .with_about("Diagnostic commands i.e. logs, restart, rebuild"),
         )
 }
 

diff --git a/core/startos/src/registry/db.rs b/core/startos/src/registry/db.rs
@@ -22,15 +22,20 @@ pub fn db_api<C: Context>() -> ParentHandler<C> {
             "dump",
             from_fn_async(cli_dump)
                 .with_display_serializable()
-                .with_about("Return db tables and records"),
+                .with_about("Filter/query db to display tables and records"),
         )
         .subcommand(
             "dump",
             from_fn_async(dump)
                 .with_metadata("admin", Value::Bool(true))
                 .no_cli(),
         )
-        .subcommand("apply", from_fn_async(cli_apply).no_display().with_about("Update a db record"))
+        .subcommand(
+            "apply",
+            from_fn_async(cli_apply)
+                .no_display()
+                .with_about("Update a db record"),
+        )
         .subcommand(
             "apply",
             from_fn_async(apply)