From 38c5e18b94c1f2f506b89cfa582b4aba80fe48d7 Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Mon, 5 Aug 2024 14:32:56 -0500 Subject: Add python and a bunch of documentation Signed-off-by: Matt Strapp --- src/lib.rs | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'src/lib.rs') 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 { -- cgit v1.2.3