document_functions_to_dir

Function document_functions_to_dir 

Source
pub fn document_functions_to_dir(
    functions: &[Box<dyn Function>],
    output_dir: &Path,
    extension: &str,
) -> Result<()>
Expand description

Writes function documentation files into output_dir

§Errors

  • Failed to create output_dir.
  • Failed to write or create file in output_dir.
  • JSON serialization error.

§Panics

Will panic if any function’s example has an input that is not valid JSON