From cb2a5087ff718f3272ca71554708af4fe2346edb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fe=CC=81lix=20Saparelli?= Date: Mon, 14 Oct 2024 23:29:20 +1300 Subject: [PATCH] doc: fix watchexec lib.rs doc comment links --- crates/lib/src/lib.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/crates/lib/src/lib.rs b/crates/lib/src/lib.rs index 589a7058..7c567276 100644 --- a/crates/lib/src/lib.rs +++ b/crates/lib/src/lib.rs @@ -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: +//! Also see the CLI tool: //! //! 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.**