From 2fd4fd7222c3d8249fb9210701f644b9fd0d9762 Mon Sep 17 00:00:00 2001
From: Tei Roberts <ten3roberts@gmail.com>
Date: Sun, 15 Oct 2023 17:53:24 +0200
Subject: [PATCH] chore: document `name` special handling

---
 src/components.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/components.rs b/src/components.rs
index 9d3103c..9eebe1b 100644
--- 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.
     ///