2024-heraklion-ODD/exercises/exercises2023/Exercise 5 Documentation.md

426 B

Exercise 5: Documentation

Goal

Practice writing doctrings

Tasks

As an exercise, write the docstring for the make_python_expert function you just wrote.

For a more detailed description, see: https://numpydoc.readthedocs.io/en/latest/format.html

Commit your documenatation and update your pull request.

If you are done, think about which parts of the brewing package should be documented and in what way.