Document subsystem name structure

Finomnis · Jan 10, 2025 · 4602be1 · 4602be1
1 parent fcfacb1
commit 4602be1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/subsystem/subsystem_handle.rs b/src/subsystem/subsystem_handle.rs
@@ -331,6 +331,9 @@ impl<ErrType: ErrTypeTraits> SubsystemHandle<ErrType> {
 
     /// Get the name associated with this subsystem.
     ///
+    /// Note that the names of nested subsystems are built unix-path alike,
+    /// starting and delimited by slashes (e.g. `/a/b/c`).
+    /// 
     /// See [`SubsystemBuilder::new()`] how to set this name.
     pub fn name(&self) -> &str {
         &self.inner.name