summaryrefslogtreecommitdiffstats
path: root/src/poem/anthology/source.rs
diff options
context:
space:
mode:
authorRory Dudley2024-03-31 00:50:03 -0600
committerRory Dudley2024-03-31 00:50:03 -0600
commit791b61f97e3ee12dfd765f5e23edd5df527eb803 (patch)
treebeec5cfab87229b84897aa038b514e08d4532665 /src/poem/anthology/source.rs
parentf03f4e0fcf62c9b3267bc5d8b62068d89ec593cd (diff)
downloaddwarvish-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/source.rs')
-rw-r--r--src/poem/anthology/source.rs9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/poem/anthology/source.rs b/src/poem/anthology/source.rs
index b4148cb..ed4ed13 100644
--- a/src/poem/anthology/source.rs
+++ b/src/poem/anthology/source.rs
@@ -3,6 +3,15 @@ use crate::poem::Verse;
use crate::poem::{read::Readable, recite::Reciteable, Poem};
use std::fs;
+/// source
+///
+/// The builtin `source` command. Used to change the shell's global environment
+/// state via a `.sh` or `.dwvsh` file.
+///
+/// # Shell Examples
+/// ```sh
+/// source ~/.dwvshrc
+/// ```
pub fn incant(verse: &Verse, env: &mut Environment) -> i32 {
let files = match verse.clause() {
Some(clause) => clause,