From dd83deb1505a8a441285a8bdefb10de25dcd5c01 Mon Sep 17 00:00:00 2001 From: Leynos Date: Tue, 29 Jul 2025 18:00:24 +0100 Subject: [PATCH 1/2] Add CLI module documentation --- src/main.rs | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/src/main.rs b/src/main.rs index 948a7533..2098f784 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,11 +1,9 @@ -//! Command-line interface for the `mdtablefix` tool. +//! Command-line interface for `mdtablefix`. //! -//! 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. +//! Parses command-line arguments and coordinates file processing. When paths +//! are supplied, each file can be rewritten in place and processing is +//! parallelised with Rayon. Without paths the tool reads from standard input. +//! Outputs always appear in the same order the paths were provided. use std::{ borrow::Cow, From 0d74e331e4863423df1a2db1da55b8a97d8cccf1 Mon Sep 17 00:00:00 2001 From: Leynos Date: Sat, 2 Aug 2025 00:02:22 +0100 Subject: [PATCH 2/2] Refine module doc comments --- src/main.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main.rs b/src/main.rs index 2098f784..9dd3c4fc 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,9 +1,9 @@ //! Command-line interface for `mdtablefix`. //! -//! Parses command-line arguments and coordinates file processing. When paths -//! are supplied, each file can be rewritten in place and processing is -//! parallelised with Rayon. Without paths the tool reads from standard input. -//! Outputs always appear in the same order the paths were provided. +//! Parses command-line arguments and coordinate file processing. When paths are +//! supplied, each file can be rewritten in place and processing is +//! parallelized with Rayon. Without paths the tool reads from standard input. +//! Output always appears in the same order as the paths are provided. use std::{ borrow::Cow,