Documenting Python Code: A Complete Guide (Overview)
In this course, you’ll learn how to document your Python code! Documenting your code is important because it can help developers and users fully understand its usage and purpose.
You’ll learn about:
- The reasons thatdocumenting your code is so important
- The differences betweencommenting and documenting
- Best practices fordocstrings
00:00Hello there! And welcome to the Real Python tutorial for Documenting Your PythonCode. My name is Andrew Stephen, and I will be your guide.If you choose to continue this tutorial, you will learn about the following:Why documenting your code is so important, commenting versus documenting yourcode and the key differences,documenting your Python code base using docstrings,and finally, documenting your Python projects and how to go about doing so.
00:29Hopefully, this small introduction has whetted your appetite for Pythondocumentation and has given you a brief outline as to what we’re going to cover,and hopefully it’ll help you. If so,I look forward to seeing you in the next video:Why Documenting Your Code Is So Important.
Course Contents
