aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib.rs
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-08-05 14:32:56 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-08-05 14:32:56 -0500
commit38c5e18b94c1f2f506b89cfa582b4aba80fe48d7 (patch)
treeee0b2a7cec961f3f2d04057e269695eddf132afc /src/lib.rs
parentNothing? (diff)
downloadlocusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.gz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.bz2
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.lz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.xz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.zst
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.zip
Add python and a bunch of documentation
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs13
1 files changed, 12 insertions, 1 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 4054f90..a77349a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,16 @@
#![no_std]
-pub fn introduce_locusts(){}
+/// Add locusts to your codebase.
+///
+/// Note that locusts are not included with this package, you must provide your own.
+///
+/// # Examples
+///
+/// ```
+/// use locusts::introduce_locusts;
+///
+/// introduce_locusts();
+/// ```
+pub fn introduce_locusts() {}
#[cfg(test)]
mod tests {