Merge pull request #192 from azriel91/maintenance/187/rename-item-to-…

…step-spike
azriel91 · Jun 2, 2024 · a0acfb9 · a0acfb9
2 parents c19100c + 5256d1a
commit a0acfb9
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/crate/cmd/src/scopes/multi_profile_no_flow.rs b/crate/cmd/src/scopes/multi_profile_no_flow.rs
@@ -15,7 +15,7 @@ use serde::{de::DeserializeOwned, Serialize};
 
 use crate::ctx::CmdCtxTypes;
 
-/// A command that works with multiple profiles, without any items.
+/// A command that works with multiple profiles, not scoped to a flow.
 ///
 /// ```bash
 /// path/to/repo/.peace/envman
@@ -94,7 +94,7 @@ where
     >,
 }
 
-/// A command that works with multiple profiles, without any items.
+/// A command that works with multiple profiles, not scoped to a flow.
 ///
 /// ```bash
 /// path/to/repo/.peace/envman

diff --git a/crate/cmd/src/scopes/single_profile_no_flow.rs b/crate/cmd/src/scopes/single_profile_no_flow.rs
@@ -15,7 +15,7 @@ use serde::{de::DeserializeOwned, Serialize};
 
 use crate::ctx::CmdCtxTypes;
 
-/// A command that works with a single profile, without any items.
+/// A command that works with a single profile, not scoped to a flow.
 ///
 /// ```bash
 /// path/to/repo/.peace/envman
@@ -84,7 +84,7 @@ where
     >,
 }
 
-/// A command that works with a single profile, without any items.
+/// A command that works with a single profile, not scoped to a flow.
 ///
 /// ```bash
 /// path/to/repo/.peace/envman

diff --git a/crate/rt_model_core/src/error/web_error.rs b/crate/rt_model_core/src/error/web_error.rs
@@ -123,7 +123,8 @@ pub enum WebError {
     },
     /// Failed to remove an item from browser storage.
     ///
-    /// This failure mode happens when the `get_item` call to the browser fails.
+    /// This failure mode happens when the `remove_item` call to the browser
+    /// fails.
     ///
     /// Note: The original `JsValue` error is converted to a `String` to allow
     /// this type to be `Send`.

diff --git a/doc/src/technical_concepts/item.md b/doc/src/technical_concepts/item.md
@@ -167,7 +167,7 @@ Cleans up the item from existence.
 
 Readers may notice the function breakdown is `git`-like. The following table compares the concepts:
 
-| Subject                | Peace                                                  | Git                                                                                      |
+| Concept                | Peace                                                  | Git                                                                                      |
 |:-----------------------|:-------------------------------------------------------|:-----------------------------------------------------------------------------------------|
 | Item                   | Any consumer defined item.                             | A directory of files.                                                                    |
 | Project initialization | `init` command takes in parameters to manage the item. | Uses the current directory or passed in directory.                                       |