diff --git a/README.md b/README.md index 24ad540f..00d3fde4 100644 --- a/README.md +++ b/README.md @@ -61,10 +61,10 @@ mdtablefix [--wrap] [--renumber] [--breaks] [--ellipsis] [--fences] [--footnotes ## Concurrency -When multiple file paths are supplied the tool processes them in parallel using -the [`rayon`](https://docs.rs/rayon) crate. Results are buffered so they can be -printed in the original order. This coordination uses extra memory and can -outweigh the speed gains when each file is small. +When multiple file paths are supplied, `mdtablefix` processes them in parallel +using the [`rayon`](https://docs.rs/rayon) crate. The CLI buffers each result, +so it can print them in the original order. This buffering uses extra memory. +It might outweigh the speed gains for small files. ### Example: Table Reflowing diff --git a/src/main.rs b/src/main.rs index d7dee4d8..0948ed81 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,10 +1,11 @@ -//! Command-line interface for the mdtablefix tool. +//! Command-line interface for the `mdtablefix` tool. //! -//! This module provides the main entry point and CLI parsing for fixing -//! markdown table formatting. It processes multiple files concurrently using -//! Rayon. Each worker buffers its output so lines can be printed in the same -//! order the paths were supplied. For many small files this coordination cost -//! may outweigh the benefits of parallelism. +//! This module provides the main entry point for the command-line parsing in +//! the `mdtablefix` crate. It fixes Markdown table formatting and processes +//! multiple files concurrently using the `rayon` crate. Each worker buffers +//! its output so lines can be printed in the same order the paths were +//! supplied. For many small files, this coordination cost may outweigh the +//! benefits of parallelism. use std::{ borrow::Cow,