1
1
PEP: 257
2
2
Title: Docstring Conventions
3
- Version: $Revision$
4
- Last-Modified: $Date$
5
3
Author: David Goodger <
[email protected] >,
6
4
Guido van Rossum <
[email protected] >
7
5
8
6
Status: Active
9
7
Type: Informational
10
- Content-Type: text/x-rst
11
8
Created: 29-May-2001
12
9
Post-History: 13-Jun-2001
13
10
@@ -74,8 +71,7 @@ detailed description of attribute and additional docstrings.
74
71
75
72
For consistency, always use ``"""triple double quotes""" `` around
76
73
docstrings. Use ``r"""raw triple double quotes""" `` if you use any
77
- backslashes in your docstrings. For Unicode docstrings, use
78
- ``u"""Unicode triple-quoted strings""" ``.
74
+ backslashes in your docstrings.
79
75
80
76
There are two forms of docstrings: one-liners and multi-line
81
77
docstrings.
@@ -276,9 +272,9 @@ Once trimmed, these docstrings are equivalent::
276
272
References and Footnotes
277
273
========================
278
274
279
- .. _Docutils : http ://docutils.sourceforge.net /
275
+ .. _Docutils : https ://docutils.sourceforge.io /
280
276
281
- .. _Doc-SIG : http ://www.python.org/sigs/doc-sig/
277
+ .. _Doc-SIG : https ://www.python.org/community/ sigs/current /doc-sig/
282
278
283
279
284
280
Copyright
@@ -295,13 +291,3 @@ by Guido van Rossum.
295
291
296
292
This document borrows ideas from the archives of the Python Doc-SIG _.
297
293
Thanks to all members past and present.
298
-
299
-
300
-
301
- ..
302
- Local Variables:
303
- mode: indented-text
304
- indent-tabs-mode: nil
305
- fill-column: 70
306
- sentence-end-double-space: t
307
- End:
0 commit comments