diff options
author | Rory Dudley | 2024-03-31 00:50:03 -0600 |
---|---|---|
committer | Rory Dudley | 2024-03-31 00:50:03 -0600 |
commit | 791b61f97e3ee12dfd765f5e23edd5df527eb803 (patch) | |
tree | beec5cfab87229b84897aa038b514e08d4532665 /src/poem/anthology/exit.rs | |
parent | f03f4e0fcf62c9b3267bc5d8b62068d89ec593cd (diff) | |
download | dwarvish-791b61f97e3ee12dfd765f5e23edd5df527eb803.tar.gz |
Add docstring comments to all the anthology functions
Add docstring comments for all the incant function throughout the
anthology, documenting what each function does, and an example of it's
shell command.
Diffstat (limited to 'src/poem/anthology/exit.rs')
-rw-r--r-- | src/poem/anthology/exit.rs | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/poem/anthology/exit.rs b/src/poem/anthology/exit.rs index ecb14f1..46fe13c 100644 --- a/src/poem/anthology/exit.rs +++ b/src/poem/anthology/exit.rs @@ -1,5 +1,12 @@ use std::process::exit; +/// exit +/// +/// The builtin `exit` command. Used to quit the shell. +/// +/// # Aliases +/// * exit +/// * quit pub fn incant() -> i32 { exit(0); } |