diff --git a/src/lib.rs b/src/lib.rs index b5b17f4..d787ab1 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -13,6 +13,12 @@ overlapping_range_endpoints )] +//! `just` is primarily used as a command-line binary, but does provide a +//! limited public library interface. +//! +//! Please keep in mind that there are no semantic version guarantees for the +//! library interface. It may break or change at any time. + pub(crate) use { crate::{ alias::Alias, analyzer::Analyzer, argument_parser::ArgumentParser, assignment::Assignment, diff --git a/src/run.rs b/src/run.rs index 5d8cf83..38b2233 100644 --- a/src/run.rs +++ b/src/run.rs @@ -1,6 +1,7 @@ use super::*; -/// Main entry point into just binary. +/// Main entry point into `just`. Parse arguments from `args` and run. `run()` +/// will exit the proceess if `args` cannot be parsed. #[allow(clippy::missing_errors_doc)] pub fn run(args: impl Iterator + Clone>) -> Result<(), i32> { #[cfg(windows)]