Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="lib.html" title='Python Library Reference' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='index' href='genindex.html' title='Index' /> | |
10 | <link rel='last' href='about.html' title='About this document...' /> | |
11 | <link rel='help' href='about.html' title='About this document...' /> | |
12 | <link rel="next" href="doctest-finding-examples.html" /> | |
13 | <link rel="prev" href="doctest-how-it-works.html" /> | |
14 | <link rel="parent" href="doctest-how-it-works.html" /> | |
15 | <link rel="next" href="doctest-finding-examples.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>5.2.3.1 Which Docstrings Are Examined?</title> | |
18 | </head> | |
19 | <body> | |
20 | <DIV CLASS="navigation"> | |
21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
23 | <tr> | |
24 | <td class='online-navigation'><a rel="prev" title="5.2.3 How It Works" | |
25 | href="doctest-how-it-works.html"><img src='../icons/previous.png' | |
26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
27 | <td class='online-navigation'><a rel="parent" title="5.2.3 How It Works" | |
28 | href="doctest-how-it-works.html"><img src='../icons/up.png' | |
29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
30 | <td class='online-navigation'><a rel="next" title="5.2.3.2 How are Docstring" | |
31 | href="doctest-finding-examples.html"><img src='../icons/next.png' | |
32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
33 | <td align="center" width="100%">Python Library Reference</td> | |
34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
35 | href="contents.html"><img src='../icons/contents.png' | |
36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
39 | <td class='online-navigation'><a rel="index" title="Index" | |
40 | href="genindex.html"><img src='../icons/index.png' | |
41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
42 | </tr></table> | |
43 | <div class='online-navigation'> | |
44 | <b class="navlabel">Previous:</b> | |
45 | <a class="sectref" rel="prev" href="doctest-how-it-works.html">5.2.3 How It Works</A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="doctest-how-it-works.html">5.2.3 How It Works</A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="doctest-finding-examples.html">5.2.3.2 How are Docstring</A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H3><A NAME="SECTION007231000000000000000"></A><A NAME="doctest-which-docstrings"></A> | |
56 | <BR> | |
57 | 5.2.3.1 Which Docstrings Are Examined? | |
58 | </H3> | |
59 | ||
60 | <P> | |
61 | The module docstring, and all function, class and method docstrings are | |
62 | searched. Objects imported into the module are not searched. | |
63 | ||
64 | <P> | |
65 | In addition, if <code>M.__test__</code> exists and "is true", it must be a | |
66 | dict, and each entry maps a (string) name to a function object, class | |
67 | object, or string. Function and class object docstrings found from | |
68 | <code>M.__test__</code> are searched, and strings are treated as if they | |
69 | were docstrings. In output, a key <code>K</code> in <code>M.__test__</code> appears | |
70 | with name | |
71 | ||
72 | <P> | |
73 | <div class="verbatim"><pre> | |
74 | <name of M>.__test__.K | |
75 | </pre></div> | |
76 | ||
77 | <P> | |
78 | Any classes found are recursively searched similarly, to test docstrings in | |
79 | their contained methods and nested classes. | |
80 | ||
81 | <P> | |
82 | ||
83 | <span class="versionnote">Changed in version 2.4: | |
84 | A "private name" concept is deprecated and no longer | |
85 | documented.</span> | |
86 | ||
87 | <P> | |
88 | ||
89 | <DIV CLASS="navigation"> | |
90 | <div class='online-navigation'> | |
91 | <p></p><hr /> | |
92 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
93 | <tr> | |
94 | <td class='online-navigation'><a rel="prev" title="5.2.3 How It Works" | |
95 | href="doctest-how-it-works.html"><img src='../icons/previous.png' | |
96 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
97 | <td class='online-navigation'><a rel="parent" title="5.2.3 How It Works" | |
98 | href="doctest-how-it-works.html"><img src='../icons/up.png' | |
99 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
100 | <td class='online-navigation'><a rel="next" title="5.2.3.2 How are Docstring" | |
101 | href="doctest-finding-examples.html"><img src='../icons/next.png' | |
102 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
103 | <td align="center" width="100%">Python Library Reference</td> | |
104 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
105 | href="contents.html"><img src='../icons/contents.png' | |
106 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
107 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
108 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
109 | <td class='online-navigation'><a rel="index" title="Index" | |
110 | href="genindex.html"><img src='../icons/index.png' | |
111 | border='0' height='32' alt='Index' width='32' /></A></td> | |
112 | </tr></table> | |
113 | <div class='online-navigation'> | |
114 | <b class="navlabel">Previous:</b> | |
115 | <a class="sectref" rel="prev" href="doctest-how-it-works.html">5.2.3 How It Works</A> | |
116 | <b class="navlabel">Up:</b> | |
117 | <a class="sectref" rel="parent" href="doctest-how-it-works.html">5.2.3 How It Works</A> | |
118 | <b class="navlabel">Next:</b> | |
119 | <a class="sectref" rel="next" href="doctest-finding-examples.html">5.2.3.2 How are Docstring</A> | |
120 | </div> | |
121 | </div> | |
122 | <hr /> | |
123 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
124 | </DIV> | |
125 | <!--End of Navigation Panel--> | |
126 | <ADDRESS> | |
127 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
128 | </ADDRESS> | |
129 | </BODY> | |
130 | </HTML> |