traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue #24531: Document that encoding lines cannot follow non-comment lines. 

Patch from Terry Reedy
This commit is contained in:
Robert Collins 2015-08-06 21:08:44 +12:00
parent 79b98df023
commit 0b2833eaf2
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/reference/lexical_analysis.rst
View File

@ -81,7 +81,9 @@ Encoding declarations
If a comment in the first or second line of the Python script matches the If a comment in the first or second line of the Python script matches the
regular expression ``coding[=:]\s*([-\w.]+)``, this comment is processed as an regular expression ``coding[=:]\s*([-\w.]+)``, this comment is processed as an
encoding declaration; the first group of this expression names the encoding of encoding declaration; the first group of this expression names the encoding of
the source code file. The recommended forms of this expression are :: the source code file. The encoding declaration must appear on a line of its
own. If it is the second line, the first line must also be a comment-only line.
The recommended forms of an encoding expression are ::
# -*- coding: <encoding-name> -*- # -*- coding: <encoding-name> -*-
@ -98,7 +100,7 @@ among others, by Microsoft's :program:`notepad`).
If an encoding is declared, the encoding name must be recognized by Python. The If an encoding is declared, the encoding name must be recognized by Python. The
encoding is used for all lexical analysis, including string literals, comments encoding is used for all lexical analysis, including string literals, comments
and identifiers. The encoding declaration must appear on a line of its own. and identifiers.
.. XXX there should be a list of supported encodings. .. XXX there should be a list of supported encodings.