Skip to content

Commit

Permalink
docs: update docs to reflect new function signatures
Browse files Browse the repository at this point in the history
  • Loading branch information
rymdtian committed Apr 9, 2024
1 parent 18d307c commit 8523fc0
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ fn validate_args(cli: &Cli) -> Result<(), String> {
///
/// # Arguments
///
/// * `img_path` - Path to the input image file.
/// * `img` - Image to split.
/// * `rows` - Number of rows to split the image into. Provide a single integer for equal division, or a list of integers for custom division.
/// * `cols` - Number of columns to split the image into. Provide a single integer for equal division, or a list of integers for custom division.
///
Expand Down Expand Up @@ -190,9 +190,12 @@ fn split_image(mut img: DynamicImage, rows: &Vec<u32>, cols: &Vec<u32>) -> Vec<D
/// # Arguments
///
/// * `split_images` - A reference to a vector containing the split images.
/// * `save_directory_str` - Path to the directory where split images will be saved.
/// * `output_directory` - Path to the directory where split images will be saved.
/// * `img_file_name` - Path of image excluding parent directories and extension.
/// * `img_format` - Format of the image.
/// * `img_format_str` - String representation of the image format.
/// * `num_rows` - Number of rows the image was split into.
/// * `num_cols` _ Number of columns the image was split into.
fn save_images(
split_images: &Vec<DynamicImage>,
output_directory: &PathBuf,
Expand Down

0 comments on commit 8523fc0

Please sign in to comment.