Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://realpython.com/courses/documenting-python-code/discussion/ below:

A Complete Guide (Overview) (Video) – Real Python

• Contents
• Transcript
• Discussion

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 that documenting your code is so important
• The differences between commenting and documenting
• Best practices for docstrings

00:00 Hello there! And welcome to the Real Python tutorial for Documenting Your Python Code. 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 your code 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:29 Hopefully, this small introduction has whetted your appetite for Python documentation 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.

Become a Member to join the conversation.

Course Contents

14%

• Documenting Python Code: A Complete Guide (Overview) 00:44

• Why Documenting Your Code Is So Important 01:57

• Documenting vs Commenting Code 05:19

• Documenting With Docstrings (Part 1) 07:48

• Documenting With Docstrings (Part 2) 08:50

• Documenting Your Python Projects (Part 1) 04:35

• Documenting Your Python Projects (Part 2) 03:41

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4