From fd16b07fb161aeb0f211d83dcac18047a2590209 Mon Sep 17 00:00:00 2001 From: Youjia Li Date: Fri, 21 Jun 2024 00:12:53 -0500 Subject: [PATCH] try fixing rtd docs --- lumache.py | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 lumache.py diff --git a/lumache.py b/lumache.py new file mode 100644 index 0000000..3ea7ce9 --- /dev/null +++ b/lumache.py @@ -0,0 +1,23 @@ +""" +Lumache - Python library for cooks and food lovers. +""" + +__version__ = "0.1.0" + + +class InvalidKindError(Exception): + """Raised if the kind is invalid.""" + pass + + +def get_random_ingredients(kind=None): + """ + Return a list of random ingredients as strings. + + :param kind: Optional "kind" of ingredients. + :type kind: list[str] or None + :raise lumache.InvalidKindError: If the kind is invalid. + :return: The ingredients list. + :rtype: list[str] + """ + return ["shells", "gorgonzola", "parsley"]