paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-06 15:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs/code-style.rst: Update and clarify shebang rules.

Browse Source
This commit is contained in:
Tim Abbott
2016-05-29 05:07:50 -07:00
parent 94e4b39112
commit 1b59b6826a
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/code-style.rst
View File

@@ -352,11 +352,13 @@ styles (separate lines for each selector)::
Python
------
- Scripts should start with ``#!/usr/bin/env python2.7`` and not
``#!/usr/bin/env python2.7``. See commit ``437d4aee`` for an explanation of
why. Don't put such a line on a Python file unless it's meaningful to
run it as a script. (Some libraries can also be run as scripts, e.g.
to run a test suite.)
- Scripts should start with ``#!/usr/bin/env python`` and not
``#/usr/bin/python`` (the right Python may not be installed at
/usr/bin) or ``#/usr/bin/env/python2.7`` (bad for Python 3
compatibility). Don't put a shebang line on a Python file unless
it's meaningful to run it as a script. (Some libraries can also be
run as scripts, e.g. to run a test suite.)
- The first import in a file should be
``from __future__ import absolute_import``, per `PEP
328 <http://docs.python.org/2/whatsnew/2.5.html#pep-328-absolute-and-relative-imports>`__