Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
frasertheking committed Mar 26, 2024
1 parent 67f9c55 commit b60f4fa
Showing 1 changed file with 2 additions and 25 deletions.
27 changes: 2 additions & 25 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,9 @@
Usage
Tester
=====

Installation
------------

To use Lumache, first install it using pip:
asd asd asdasd asd

.. code-block:: console
(.venv) $ pip install lumache
Creating recipes
----------------

To retrieve a list of random ingredients,
you can use the ``lumache.get_random_ingredients()`` function:

.. autofunction:: lumache.get_random_ingredients

The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
will raise an exception.

.. autoexception:: lumache.InvalidKindError

For example:

>>> import lumache
>>> lumache.get_random_ingredients()
['shells', 'gorgonzola', 'parsley']

0 comments on commit b60f4fa

Please sign in to comment.