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 ++++++++++++- src/locusts-r-us/__init__.py | 0 src/locusts-r-us/locusts.py | 6 ++++++ src/locusts-r-us/test_locusts.py | 9 +++++++++ 4 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 src/locusts-r-us/__init__.py create mode 100644 src/locusts-r-us/locusts.py create mode 100644 src/locusts-r-us/test_locusts.py (limited to 'src') 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 { diff --git a/src/locusts-r-us/__init__.py b/src/locusts-r-us/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/locusts-r-us/locusts.py b/src/locusts-r-us/locusts.py new file mode 100644 index 0000000..f050133 --- /dev/null +++ b/src/locusts-r-us/locusts.py @@ -0,0 +1,6 @@ +def introduce_locusts(): + """ + Introduce locusts into your codebase. + + Note that locusts are not included with this package, you must provide your own. + """ diff --git a/src/locusts-r-us/test_locusts.py b/src/locusts-r-us/test_locusts.py new file mode 100644 index 0000000..68e6df7 --- /dev/null +++ b/src/locusts-r-us/test_locusts.py @@ -0,0 +1,9 @@ +import unittest +from locusts import introduce_locusts + +class TestLocusts(unittest.TestCase): + def test_introduce_locusts(self): + self.assertIsNone(introduce_locusts()) + +if __name__ == '__main__': + unittest.main() \ No newline at end of file -- cgit v1.2.3