Writing and Formatting Your Docstrings
00:00 Write and Format Your Docstrings.
00:04 The mkdocstrings package can pull valuable information from your codebase to help auto-generate parts of your documentation. As the package name suggests, you’ll need docstrings to accomplish this.
00:16 It can also make use of type hints, so you’ll reformat your function signatures and docstrings to use them. At this point, you don’t have any docstrings in your function, so it’s time to change that. In this section of the course, you’ll write docstrings for your module, the contained functions, and your package.
00:36 Let’s start this process by taking a look at what a docstring is.
Become a Member to join the conversation.
