[docs] [issue29381] Tutorial documentation contains undefined reference to #!

Jim Fasarakis-Hilliard report at bugs.python.org
Sat Jan 28 11:55:13 EST 2017


Jim Fasarakis-Hilliard added the comment:

Indeed, this does create an issue. 

The last sentence in the documentation actually specifies where the encoding comment can be but doesn't strictly specify it can be on the second line if and only if preceded by `#!`.

I'm thinking the last sentence should contain the additional change, that is, change it from :

    The special encoding comment must be in the first or second line within the file.

to:

    The special encoding comment must be in the first line, or, if the first line is used to create an executable Python script, the second line within the file.

linking to (https://docs.python.org/3/tutorial/appendix.html#executable-python-scripts) accordingly. 

Let's see what Mariatta says about these proposals. Thanks for noticing.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue29381>
_______________________________________


More information about the docs mailing list