PEP 257: Remove outdated Unicode docstring advice (#3748)
* PEP 257: Remove outdated Unicode docstring advice * PEP 257: Remove redundant headers and emacs footer * PEP 257: Update links
This commit is contained in:
parent
6f4b8ea8f4
commit
f22614f903
|
@ -1,13 +1,10 @@
|
|||
PEP: 257
|
||||
Title: Docstring Conventions
|
||||
Version: $Revision$
|
||||
Last-Modified: $Date$
|
||||
Author: David Goodger <goodger@python.org>,
|
||||
Guido van Rossum <guido@python.org>
|
||||
Discussions-To: doc-sig@python.org
|
||||
Status: Active
|
||||
Type: Informational
|
||||
Content-Type: text/x-rst
|
||||
Created: 29-May-2001
|
||||
Post-History: 13-Jun-2001
|
||||
|
||||
|
@ -74,8 +71,7 @@ detailed description of attribute and additional docstrings.
|
|||
|
||||
For consistency, always use ``"""triple double quotes"""`` around
|
||||
docstrings. Use ``r"""raw triple double quotes"""`` if you use any
|
||||
backslashes in your docstrings. For Unicode docstrings, use
|
||||
``u"""Unicode triple-quoted strings"""``.
|
||||
backslashes in your docstrings.
|
||||
|
||||
There are two forms of docstrings: one-liners and multi-line
|
||||
docstrings.
|
||||
|
@ -276,9 +272,9 @@ Once trimmed, these docstrings are equivalent::
|
|||
References and Footnotes
|
||||
========================
|
||||
|
||||
.. _Docutils: http://docutils.sourceforge.net/
|
||||
.. _Docutils: https://docutils.sourceforge.io/
|
||||
|
||||
.. _Doc-SIG: http://www.python.org/sigs/doc-sig/
|
||||
.. _Doc-SIG: https://www.python.org/community/sigs/current/doc-sig/
|
||||
|
||||
|
||||
Copyright
|
||||
|
@ -295,13 +291,3 @@ by Guido van Rossum.
|
|||
|
||||
This document borrows ideas from the archives of the Python Doc-SIG_.
|
||||
Thanks to all members past and present.
|
||||
|
||||
|
||||
|
||||
..
|
||||
Local Variables:
|
||||
mode: indented-text
|
||||
indent-tabs-mode: nil
|
||||
fill-column: 70
|
||||
sentence-end-double-space: t
|
||||
End:
|
||||
|
|
Loading…
Reference in New Issue