Fix some minor weirdness when Pilcrow is (unwisely) used as a library.

Pilcrow isn't meant to be used as a library, and the only public interface the `pilcrow` lib crate exposes is the CLI entry point. However, we will likely be publishing Pilcrow via crates.io (among other options) one day, and so it will _be usable_ as a library if someone's desperate enough to try. To that end, let's try to be good citizens.

This change fixes two issues:

* The docs contained links to internal items, which are not actually included in the library documentation. The links are simply removed; the uses of those items were already private anyways.

* The CLI `Error` type is no longer part of the public interface, using `impl Trait` (`impl std::error::Error`) shenanigans to hide the error type from callers. (To be clear, this would be _extremely_ rude in code intended for library use.) This frees us up to change the structure of the error type - or to replace it entirely - without making the world's most pedantic semver change in the process.

Merges lib-crate-weirdness into main.

1 files changed, 0 insertions, 4 deletions

diff --git a/src/umask.rs b/src/umask.rs
index 32a82ad..6aef33a 100644
--- a/src/umask.rs
+++ b/src/umask.rs
@@ -100,15 +100,11 @@ impl fmt::Display for Umask {
     }
 }
 
-/// Errors occurring during umask option parsing.
 #[derive(Debug, thiserror::Error)]
 pub enum Error {
-    /// Failed to parse a umask value from the input.
     #[error(transparent)]
     Parse(#[from] std::num::ParseIntError),
 
-    /// The provided umask contained invalid bits. (See the constants associated with [`Mode`] for
-    /// valid umask bits.)
     // We dont need to hold onto the actual umask value here - Clap does that for us, and prints
     // the value as the user input it, which beats anything we could do here.
     #[error("unknown bits in umask")]