Adhere all documentation to API guidelines strictly

[maxfierrog]

See https://rust-lang.github.io/api-guidelines/documentation.html

In particular, note the importance of the following structure:

/// Quick one-sentence explanation.
///
/// In-depth explanation, possibly spanning multiple paragraphs...
///
/// # Example
///
/// ```no_run
/// let example = something();
/// ...
/// ```
///
/// # Errors
///
/// The exact circumstances under which this errors...
///
/// # Panics
///
/// The exact circumstances under which this panics...
pub fn something(cond: u32) -> Result<()> {
  if cond == 0 {
    panic!()
  } else if cond == 1 {
    Err(anyhow!("Error"))
  } else {
    Ok(())
  }
}

Recommended Courses (UC Berkeley)

This issue just requires the ability to read Rust and write grammatically correct and well-structured English.

• CS 61B (minimum)