Added documentation about what the "system supervisor" is.

bastion/src/bastion.rs

@@ -217,13 +217,16 @@ impl Bastion {
     }
 
     /// Creates a new [`Children`], passes it through the specified
-    /// `init` closure and then sends it to the system's default
-    /// supervisor for it to start supervising it.
+    /// `init` closure and then sends it to the system supervisor
+    /// for it to start supervising it.
     ///
     /// This methods returns a [`ChildrenRef`] referencing the newly
     /// created children group it it succeeded, or `Err(())`
     /// otherwise.
     ///
+    /// Note that the "system supervisor" is a supervisor created
+    /// by the system at startup.
+    ///
     /// # Arguments
     ///
     /// * `init` - The closure taking the new [`Children`] as an

bastion/src/context.rs

@@ -120,8 +120,8 @@ impl BastionContext {
 
     /// Returns a [`SupervisorRef`] referencing the supervisor
     /// that supervises the element that is linked to this
-    /// `BastionContext` if it isn't the system's supervisor
-    /// (if the children group wasn't created using
+    /// `BastionContext` if it isn't the system supervisor
+    /// (ie. if the children group wasn't created using
     /// [`Bastion::children`]).
     ///
     /// # Example

bastion/src/supervisor.rs

@@ -22,6 +22,10 @@ use std::task::Poll;
 /// supervisor will restart it and eventually some of its other
 /// supervised entities, depending on its supervision strategy.
 ///
+/// Note that a supervisor, called the "system supervisor", is
+/// created by the system at startup and is the supervisor
+/// supervising children groups created via [`Bastion::children`].
+///
 /// # Example
 ///
 /// ```
@@ -45,6 +49,7 @@ use std::task::Poll;
 /// [`Children`]: children/struct.Children.html
 /// [`SupervisionStrategy`]: supervisor/enum.SupervisionStrategy.html
 /// [`with_strategy`]: #method.with_strategy
+/// [`Bastion::children`]: struct.Bastion.html#method.children
 pub struct Supervisor {
     bcast: Broadcast,
     // The order in which children and supervisors were added.