documentation.HELP! Python PEP Documentation

5.2.3 How It Works

Python PEP

previous page next page

Previous: 5.2.2 Simple Usage: Checking Up: 5.2 doctest Next: 5.2.3.1 Which Docstrings Are

---

5.2.3 How It Works

This section examines in detail how doctest works: which docstrings it looks at, how it finds interactive examples, what execution context it uses, how it handles exceptions, and how option flags can be used to control its behavior. This is the information that you need to know to write doctest examples; for information about actually running doctest on these examples, see the following sections.

---

Subsections

• 5.2.3.1 Which Docstrings Are Examined?
• 5.2.3.2 How are Docstring Examples Recognized?
• 5.2.3.3 What's the Execution Context?
• 5.2.3.4 What About Exceptions?
• 5.2.3.5 Option Flags and Directives
• 5.2.3.6 Warnings

---

Python Library Reference

Previous: 5.2.2 Simple Usage: Checking Up: 5.2 doctest Next: 5.2.3.1 Which Docstrings Are

---

Release 2.4, documentation updated on 29 November 2004.

See About this document... for information on suggesting changes.

previous page start next page

Get in touch

Submit feedback about this site to:

• [email protected]