DEV Community

Play Button Pause Button
Cheuk Ting Ho 🐍
Cheuk Ting Ho 🐍

Posted on

Python Zero to Hero - Ep.17 - Python docs

To make code usable we have to ensure users and developers know what the code is doing. We can add comments to explain thing but it's still limited. That's why we need to write docstrings in Python and with a bit of magic (a.k.a Sphinx) we can make the docstrings into a documentation website. If you have any questions or any suggestions about which Python topics to cover, please leave your comment at my Twitch channel

You can get the slide deck here and the example code and homework form GitHub here. Ask questions at my Twitch channel

Top comments (0)