diff --git a/libs/chonky/README.md b/libs/chonky/README.md index 99cd35164c8..8ded43a6548 100644 --- a/libs/chonky/README.md +++ b/libs/chonky/README.md @@ -25,7 +25,7 @@ The library relies on common Rust tools as configured in the repository root. Th ## Usage -To run this package, a compiled static library of `pdfium-render` must be provided. The library should be held in `libs/pdfium-lib` folder in the `Chonky` package, the precompiled binary for MacOS has been included in this repo. We pass the environment variable of the full path of the libary once when running `cargo build` +To run this package, a compiled static library of `pdfium-render` must be provided. The library should be held in `libs/pdfium-lib` folder in the `Chonky` package, the precompiled binary for `MacOS` has been included in this repo. We pass the environment variable of the full path of the libary once when running `cargo build` ```sh PDFIUM_STATIC_LIB_PATH=/path/to/static/lib cargo build diff --git a/libs/chonky/src/lib.rs b/libs/chonky/src/lib.rs index 34b1ff3fe41..edddee8e1dc 100644 --- a/libs/chonky/src/lib.rs +++ b/libs/chonky/src/lib.rs @@ -69,8 +69,9 @@ pub mod pdf_segmentation { /// /// # Errors /// - /// Return an [`PdfiumError::ImageError`] if there was a problem with the image processing - /// operation, occurs when image cannot be encoded into specific image format + /// Return an [`ChonkyError::Pdfium`] if there was a + /// problem with the image processing operation, occurs when image cannot be encoded into + /// specific image format pub fn pdf_to_images(pdf: &PdfDocument) -> Result, Report> { let mut images: Vec = Vec::new(); @@ -100,7 +101,7 @@ pub mod pdf_segmentation { /// /// # Errors /// - /// Return an [`PdfiumError::CoordinateConversionFunctionIndicatedError`] if there was a problem + /// Return an [`ChonkyError::Pdfium`] if there was a problem /// with converting the pdfs dimensions to pixels fn create_empty_bitmap<'a>( pdf: &'a PdfDocument, @@ -153,7 +154,7 @@ pub mod pdf_segmentation { /// /// Errors# /// - /// [`PdfiumError::ImageError`] when the image had an error being processed + /// [`ChonkyError::Pdfium`] when the image had an error being processed fn as_image(bitmap: &PdfBitmap) -> Result> { let bytes = bitmap.as_rgba_bytes();