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

What’s Included:

• 7 Lessons
• Video Subtitles and Full Transcripts
• 2 Downloadable Resources
• Accompanying Text-Based Tutorial
• Q&A With Python Experts: Ask a Question
• Certificate of Completion

Downloadable Resources:

• Course Slides (PDF)
• Sample Code (.zip)

Related Learning Paths:

• Write More Pythonic Code

Documenting Python Code: A Complete Guide

7 Lessons 32m

1. 1. Documenting Python Code: A Complete Guide (Overview)00:44
2. 2. Why Documenting Your Code Is So Important01:57
3. 3. Documenting vs Commenting Code05:19
4. 4. Documenting With Docstrings (Part 1)07:48
5. 5. Documenting With Docstrings (Part 2)08:50
6. 6. Documenting Your Python Projects (Part 1)04:35
7. 7. Documenting Your Python Projects (Part 2)03:41

AboutAndrew Stephen

Andrew is an avid Pythonista and creates video tutorials for Real Python. He is a qualified robotics and mechatronics engineer who works for an engineering firm as a production engineer and loves his sport, music, gaming and learning.

» More about Andrew

Each tutorial at Real Python is created by a team of developers so that it meets our high quality standards. The team members who worked on this tutorial are:

Dan

Joanna

Sadie

Tappan

James

Aldren

Related Courses:

Exploring Basic Data Types in Python

Building Python Project Documentation With MkDocs