chore: document name special handling

ten3roberts · Oct 15, 2023 · 2fd4fd7 · 2fd4fd7
1 parent 30843f7
commit 2fd4fd7
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/components.rs b/src/components.rs
@@ -10,7 +10,10 @@ use crate::component::ComponentDesc;
 use crate::Debuggable;
 
 component! {
-    /// A name for an entity of component
+    /// An opinionated name component, so that different libraries can agree on a "name" or "label"
+    /// kind of component.
+    ///
+    /// This name will be used in *Display* and *Debug* impls of entities to make them more readable, as opposed to just the id.
     pub name: String => [ Debuggable ],
     /// Exclusive parent-child relation ship.
     ///