libcore: make spawn_supervised documentation reflect its behaviour.

huonw · Apr 18, 2013 · f43fc5f · f43fc5f · thestinger · Apr 18, 2013
1 parent d32d4d1
commit f43fc5f
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/libcore/task/mod.rs b/src/libcore/task/mod.rs
@@ -466,8 +466,9 @@ pub fn spawn_unlinked(f: ~fn()) {
 
 pub fn spawn_supervised(f: ~fn()) {
     /*!
-     * Creates a child task unlinked from the current one. If either this
-     * task or the child task fails, the other will not be killed.
+     * Creates a child task supervised by the current one. If the child
+     * task fails, the parent will not be killed, but if the parent fails,
+     * the child will be killed.
      */
 
     task().supervised().spawn(f)