From a5df5a88400e64ea752c396bfbea868df2f3f714 Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Fri, 18 Jul 2025 00:58:10 -0400 Subject: Stop linking to private documentation items in public docs. The Pilcrow crate library docs are something of a wart; Pilcrow isn't meant to be used as a library, and the only public interface it exposes is the CLI entry point. However, we will likely be publishing Pilcrow via crates.io (among other options), and so it will _be usable_ as a library if you're desperate enough to try. The docs should at least be coherent. --- src/cli.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/cli.rs b/src/cli.rs index 57c5c07..8dac8ff 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -142,9 +142,9 @@ fn started_msg(listener: &net::TcpListener) -> io::Result { #[derive(Debug, thiserror::Error)] #[error(transparent)] pub enum Error { - /// Failure due to `io::Error`. See [`io::Error`]. + /// Failure due to an I/O-related error. Io(#[from] io::Error), - /// Failure due to a database initialization error. See [`db::Error`]. + /// Failure due to a database initialization error. Database(#[from] db::Error), /// Failure due to invalid umask-related options. Umask(#[from] umask::Error), -- cgit v1.2.3