SciPost Code Repository

Skip to content
Snippets Groups Projects
Commit c1a8a24f authored by Jean-Sébastien Caux's avatar Jean-Sébastien Caux
Browse files

Tweak editorconfig and docs to better fit Black

parent 68a56f5d
No related branches found
No related tags found
No related merge requests found
......@@ -12,7 +12,7 @@ charset = utf-8
# Docstrings and comments use max_line_length = 99
[*.py]
max_line_length = 99
max_line_length = 88
# Use 2 spaces for the HTML files
[*.html]
......@@ -41,4 +41,4 @@ indent_style = tab
indent_style = tab
[docs/**.txt]
max_line_length = 99
\ No newline at end of file
max_line_length = 88
\ No newline at end of file
......@@ -17,6 +17,11 @@ Coding conventions
Our starting points are the `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_
specification, and the `Django style <https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/>`_.
We further default to the conventions in Black.
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
Hereby follow some extra specializations.
To ease your work, if you have an editor with
......@@ -26,14 +31,14 @@ you can use our ``.editorconfig`` file at the base of the repository.
Line length
-----------
We deviate from `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_
and set the maximal line length to 99.
and set the maximal line length to 88.
Docstrings
----------
Docstrings are in reStructruredText (of course), and should fit within the
allowed line length of 99.
allowed line length of 88.
Templates
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment