summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOwen Jacobson <owen@grimoire.ca>2025-07-18 00:58:10 -0400
committerOwen Jacobson <owen@grimoire.ca>2025-07-22 18:07:25 -0400
commita5df5a88400e64ea752c396bfbea868df2f3f714 (patch)
tree301613ad25cf3c9cfdc00f137c250dabd06b5ceb
parent64639acbab02aa4103cbe44199e38991269b2137 (diff)
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.
-rw-r--r--src/cli.rs4
1 files 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<String> {
#[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),