mirrors/xonsh
1
0
Fork 0
mirror of https://github.com/xonsh/xonsh.git synced 2025-03-04 08:24:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update style guide to match reality

Browse source 
* black likes double quotes instead of single quotes.
* Python 3.4 is not a target anymore.
This commit is contained in:
Alexander Steffen 2019-07-13 10:44:55 +02:00
parent 7c58c8222d
commit fa2594318d
1 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.rst
View file

@ -101,15 +101,14 @@ is open to interpretation.
* Use absolute imports (``import xonsh.tools``) rather than explicit * Use absolute imports (``import xonsh.tools``) rather than explicit
relative imports (``import .tools``). Implicit relative imports relative imports (``import .tools``). Implicit relative imports
(``import tools``) are never allowed. (``import tools``) are never allowed.
* Use ``'single quotes'`` for string literals, and * Use ``"double quotes"`` for string literals, and
``"""triple double quotes"""`` for docstrings. Double quotes are allowed to ``"""triple double quotes"""`` for docstrings.
prevent single quote escaping, e.g. ``"Y'all c'mon o'er here!"``
* We use sphinx with the numpydoc extension to autogenerate API documentation. Follow * We use sphinx with the numpydoc extension to autogenerate API documentation. Follow
the `numpydoc`_ standard for docstrings. the `numpydoc`_ standard for docstrings.
* Simple functions should have simple docstrings. * Simple functions should have simple docstrings.
* Lines should be at most 80 characters long. The 72 and 79 character * Lines should be at most 80 characters long. The 72 and 79 character
recommendations from PEP8 are not required here. recommendations from PEP8 are not required here.
* All Python code should be compliant with Python 3.4+. At some * All Python code should be compliant with Python 3.5+. At some
unforeseen date in the future, Python 2.7 support *may* be supported. unforeseen date in the future, Python 2.7 support *may* be supported.
* Tests should be written with pytest using a procedural style. Do not use * Tests should be written with pytest using a procedural style. Do not use
unittest directly or write tests in an object-oriented style. unittest directly or write tests in an object-oriented style.