Update documentation for impl Command for SimpleCommand

magicant · Jun 22, 2023 · 8575eb3 · 8575eb3
1 parent 24aa59a
commit 8575eb3
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/yash-semantics/src/command/simple_command.rs b/yash-semantics/src/command/simple_command.rs
@@ -111,6 +111,10 @@ use yash_syntax::syntax::Redir;
 /// After executing the function body, the contexts are
 /// [popped](yash_env::variable::VariableSet::pop_context).
 ///
+/// If the execution results in a [`Divert::Return`], it is consumed, and its
+/// associated exit status, if any, is set as the exit status of the simple
+/// command.
+///
 /// ## External utility
 ///
 /// If the target is an external utility, a subshell is created.  Redirections