From b0aa26e87f04f059d603a2eda1f91e0624f2206c Mon Sep 17 00:00:00 2001 From: Leynos Date: Thu, 31 Jul 2025 11:33:11 +0100 Subject: [PATCH] Deprecate html_table_to_markdown --- docs/architecture.md | 5 ++++- src/lib.rs | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 22fc4d56..61739015 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -190,7 +190,7 @@ classDiagram class html { <> +convert_html_tables() - +html_table_to_markdown() + +html_table_to_markdown() %% deprecated } class table { <> @@ -264,6 +264,9 @@ streaming helpers that combine the lower-level functions, including ellipsis replacement and footnote conversion. The `io` module handles filesystem operations, delegating the text processing to `process`. +The helper `html_table_to_markdown` is retained for backward compatibility but +is deprecated. New code should call `convert_html_tables` instead. + ## Concurrency with `rayon` `mdtablefix` uses the `rayon` crate to process multiple files concurrently. diff --git a/src/lib.rs b/src/lib.rs index 9ae0f228..197edba1 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -31,7 +31,7 @@ mod reflow; pub mod table; pub mod wrap; -#[doc(hidden)] +#[deprecated(note = "this function is legacy; use `convert_html_tables` instead")] #[must_use] pub fn html_table_to_markdown(lines: &[String]) -> Vec { html::html_table_to_markdown(lines)