Skip to content

Commit

Permalink
Move exit status section after errors section
Browse files Browse the repository at this point in the history
It is more natural to read the errors section first, and then the exit
status section which usually refers to the just-described errors.

See also commit c97e4e3.
  • Loading branch information
magicant committed Dec 29, 2023
1 parent 5e50832 commit 523e55c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions yash-builtin/src/pwd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,17 @@
//!
//! None.
//!
//! # Exit Status
//!
//! Zero if the path was successfully printed; non-zero otherwise.
//!
//! # Errors
//!
//! This built-in may fail for various reasons. For example:
//! - The working directory has been removed from the file system.
//! - You do not have permission to access the ancestor directories of the working directory.
//! - The standard output is not writable.
//!
//! # Exit Status
//!
//! Zero if the path was successfully printed; non-zero otherwise.
//!
//! # Portability
//!
//! The `-L` and `-P` options are defined in POSIX.
Expand Down
8 changes: 4 additions & 4 deletions yash-builtin/src/typeset.rs
Original file line number Diff line number Diff line change
Expand Up @@ -225,10 +225,6 @@
//! may fail if functions are read-only since the read-only functions cannot be
//! redefined.
//!
//! # Exit status
//!
//! Zero unless an error occurs.
//!
//! # Errors
//!
//! The read-only attribute cannot be removed from a variable or function. If a
Expand All @@ -239,6 +235,10 @@
//! When printing variables or functions, it is an error if an operand names a
//! non-existing variable or function.
//!
//! # Exit status
//!
//! Zero unless an error occurs.
//!
//! # Portability
//!
//! The typeset built-in is not specified by POSIX and many shells implement it
Expand Down

0 comments on commit 523e55c

Please sign in to comment.