Revise exit status section

README.md

@@ -45,6 +45,7 @@ fn main() {
             Section::new("usage note")
                 .paragraph("This program will overwrite any file currently stored at the output path")
         )
+        .exit_status(ExitStatus::default())
         .render();
 
     println!("{}", page);

examples/main.rs

@@ -48,6 +48,7 @@ fn main() {
         .paragraph("text for the custom section")
         .paragraph("Additional text for the custom section"),
     )
+    .exit_status(ExitStatus::default())
     .author(Author::new("Alice Person").email("[email protected]"))
     .author(Author::new("Bob Human").email("[email protected]"))
     .render();

src/exit_status.rs

@@ -0,0 +1,30 @@
+/// Add a exit status section
+#[derive(Debug, Clone, Default)]
+pub struct ExitStatus {
+  pub(crate) code: Option<i32>,
+  pub(crate) description: Option<&'static str>,
+  pub(crate) use_default_instead: bool,
+}
+
+impl ExitStatus {
+  pub fn new(code: i32) -> Self {
+    Self {
+      code: Some(code),
+      description: None,
+      use_default_instead: false,
+    }
+  }
+
+  pub fn default() -> Self {
+    Self {
+      code: None,
+      description: None,
+      use_default_instead: true,
+    }
+  }
+
+  pub fn description(mut self, description: &'static str) -> Self {
+    self.description = Some(description);
+    self
+  }
+}

src/lib.rs

@@ -9,6 +9,7 @@ mod arg;
 mod author;
 mod environment;
 mod example;
+mod exit_status;
 mod flag;
 mod man;
 mod option;
@@ -20,6 +21,7 @@ pub use arg::Arg;
 pub use author::Author;
 pub use environment::Env;
 pub use example::Example;
+pub use exit_status::ExitStatus;
 pub use flag::Flag;
 pub use man::Manual;
 pub use option::Opt;

src/man.rs

@@ -13,6 +13,7 @@ pub struct Manual {
   environment: Vec<Env>,
   arguments: Vec<Arg>,
   custom_sections: Vec<Section>,
+  exit_statuses: Vec<ExitStatus>,
   examples: Vec<Example>,
 }
 
@@ -29,6 +30,7 @@ impl Manual {
       arguments: vec![],
       environment: vec![],
       custom_sections: vec![],
+      exit_statuses: vec![],
       examples: vec![],
     }
   }
@@ -89,6 +91,11 @@ impl Manual {
     self
   }
 
+  pub fn exit_status(mut self, exit_status: ExitStatus) -> Self {
+    self.exit_statuses.push(exit_status);
+    self
+  }
+
   /// Render to a string.
   pub fn render(self) -> String {
     let man_num = 1;
@@ -108,7 +115,7 @@ impl Manual {
     for section in self.custom_sections.into_iter() {
       page = custom(page, section);
     }
-    page = exit_status(page);
+    page = exit_status(page, &self.exit_statuses);
     page = examples(page, &self.examples);
     page = authors(page, &self.authors);
     page.render()
@@ -336,9 +343,9 @@ fn env(page: Roff, environment: &[Env]) -> Roff {
 
 /// Create a `EXIT STATUS` section.
 ///
-/// ## Implementation Note
-/// This currently only returns the status code `0`, and takes no arguments. We
-/// should let it take arguments.
+/// If initialized with the default method, this will have status codes of 0
+/// (success), 1 (failure), and 101 (panic).  Alternatively, it can be initialized
+/// with custom codes and descriptions.
 ///
 /// ## Formatting
 /// ```txt
@@ -349,15 +356,32 @@ fn env(page: Roff, environment: &[Env]) -> Roff {
 ///
 ///        2      Optional error
 /// ```
-fn exit_status(page: Roff) -> Roff {
-  page.section(
-    "EXIT STATUS",
-    &[
+fn exit_status(page: Roff, exit_statuses: &[ExitStatus]) -> Roff {
+  if exit_statuses.is_empty() {
+    return page;
+  }
+  let arr = if exit_statuses
+    .iter()
+    .any(|status| status.use_default_instead)
+  {
+    vec![
       list(&[bold("0")], &["Successful program execution.\n\n"]),
       list(&[bold("1")], &["Unsuccessful program execution.\n\n"]),
       list(&[bold("101")], &["The program panicked."]),
-    ],
-  )
+    ]
+  } else {
+    let mut arr = vec![];
+    for exit_status in exit_statuses {
+      let exit_code =
+        format!("{}", exit_status.code.expect("initialized with value"));
+      let mut exit_description =
+        String::from(exit_status.description.unwrap_or(""));
+      exit_description.push_str("\n\n");
+      arr.push(list(&[bold(&exit_code)], &[exit_description]));
+    }
+    arr
+  };
+  page.section("EXIT STATUS", &arr)
 }
 
 /// Create a custom section.

src/prelude.rs

@@ -13,6 +13,7 @@ pub use arg::Arg;
 pub use author::Author;
 pub use environment::Env;
 pub use example::Example;
+pub use exit_status::ExitStatus;
 pub use flag::Flag;
 pub use man::Manual;
 pub use option::Opt;