Add a bit more structure via documentation
This commit is contained in:
parent
319729582f
commit
5d11ccaa71
|
@ -1,3 +1,5 @@
|
||||||
|
//! Command construction and configuration thereof.
|
||||||
|
|
||||||
use tokio::process::Command;
|
use tokio::process::Command;
|
||||||
|
|
||||||
/// Shell to use to run commands.
|
/// Shell to use to run commands.
|
|
@ -1,4 +1,4 @@
|
||||||
//! Watchexec has two error types: for critical and for runtime errors.
|
//! Error types for critical, runtime, and specialised errors.
|
||||||
|
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Synthetic event type, derived from inputs, triggers actions.
|
||||||
|
//!
|
||||||
//! Fundamentally, events in watchexec have three purposes:
|
//! Fundamentally, events in watchexec have three purposes:
|
||||||
//!
|
//!
|
||||||
//! 1. To trigger the launch, restart, or other interruption of a process;
|
//! 1. To trigger the launch, restart, or other interruption of a process;
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Event source for changes to files and directories.
|
||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
collections::{HashMap, HashSet},
|
collections::{HashMap, HashSet},
|
||||||
path::PathBuf,
|
path::PathBuf,
|
||||||
|
|
|
@ -27,7 +27,7 @@
|
||||||
pub mod error;
|
pub mod error;
|
||||||
pub mod event;
|
pub mod event;
|
||||||
pub mod fs;
|
pub mod fs;
|
||||||
pub mod shell;
|
pub mod command;
|
||||||
pub mod signal;
|
pub mod signal;
|
||||||
|
|
||||||
// the core experience
|
// the core experience
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Event source for signals / notifications sent to the main process.
|
||||||
|
|
||||||
use tokio::{select, sync::mpsc};
|
use tokio::{select, sync::mpsc};
|
||||||
use tracing::{debug, trace};
|
use tracing::{debug, trace};
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue