Document that fish functions cannot be background

(Documentation for fish-shell#238, fish-shell#563)
zanchey · May 10, 2013 · e5b1d89 · e5b1d89
1 parent 0c14a02
commit e5b1d89
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc_src/index.hdr.in b/doc_src/index.hdr.in
@@ -1224,6 +1224,10 @@ which the user can change <code>fish</code>'s behavior.
 -# By pressing ^Z, the user stops a currently running foreground  program and returns control to \c fish. Some programs do not support this feature, or remap it to another key. GNU Emacs uses ^X z to stop running.
 -# By using the <a href="commands.html#fg">fg</a> and <a href="commands.html#bg">bg</a> builtin commands, the user can send any currently running job into the foreground or background.
 
+Note that functions cannot be started in the background. Functions that
+are stopped and then restarted in the background using the \c bg command
+will not execute correctly.
+
 \section initialization Initialization files
 
 On startup, \c fish evaluates the files /usr/share/fish/config.fish