Robot/watchexec
1
0
Fork 0
mirror of https://github.com/watchexec/watchexec.git synced 2024-11-16 17:18:30 +01:00
Code Issues Projects Releases Packages Wiki Activity

doc: fix watchexec lib.rs doc comment links

Browse source
This commit is contained in:
Félix Saparelli 2024-10-14 23:29:20 +13:00
parent ecc3256fa4
commit cb2a5087ff
No known key found for this signature in database
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
crates/lib/src/lib.rs
View file

@ -1,13 +1,13 @@
//! Watchexec: a library for utilities and programs which respond to (file, signal, etc) events
//! primarily by launching or managing other programs.
//!
//! Also see the CLI tool: <https://watchexec.github.io/>
//! Also see the CLI tool: <https://github.com/watchexec/watchexec>
//!
//! This library is powered by [Tokio](https://tokio.rs).
//!
//! The main way to use this crate involves constructing a [`Watchexec`] around a [`Config`], then
//! running it. [`Handler`][handler::Handler]s are used to hook into Watchexec at various points.
//! The config can be changed at any time with the [`Watchexec::reconfigure()`] method.
//! running it. Handlers (defined in [`Config`]) are used to hook into Watchexec at various points.
//! The config can be changed at any time with the `config` field on your [`Watchexec`] instance.
//!
//! It's recommended to use the [miette] erroring library in applications, but all errors implement
//! [`std::error::Error`] so your favourite error handling library can of course be used.
@ -42,8 +42,8 @@
//! ```
//!
//! Alternatively, you can use the modules exposed by the crate and the external crates such as
//! [`ClearScreen`][clearscreen] and [Process Wrap][process_wrap] to build something more advanced,
//! at the cost of reimplementing the glue code.
//! [`notify`], [`clearscreen`], [`process_wrap`]... to build something more advanced, at the cost
//! of reimplementing the glue code.
//!
//! Note that the library generates a _lot_ of debug messaging with [tracing]. **You should not
//! enable printing even `error`-level log messages for this crate unless it's for debugging.**