Skip to content

Commit

Permalink
update devguide
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvanmele committed Apr 24, 2024
1 parent 59466f6 commit a8c6c49
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ insert_final_newline = true
indent_style = space
indent_size = 4
charset = utf-8
max_line_length = 120
max_line_length = 179

[*.{bat,cmd,ps1}]
end_of_line = crlf
Expand Down
3 changes: 1 addition & 2 deletions docs/devguide/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,7 @@ Naming conventions
Line length
-----------

**COMPAS uses a line length of 120 characters**. While longer than the 80 characters recommended by ``PEP8``, it is in our opinion a more reasonable limit for modern displays.
This is enforced and can be automatically set using ``black -l 120``.
**COMPAS uses a line length of 180 characters**. While longer than the 80 characters recommended by ``PEP8``, it is in our opinion a more reasonable limit for modern displays.

**Indentations are 4 spaces**. Tab to spaces setting can be set in ``.editorconfig`` which is respected by most editors. For more information see `EditorConfig <https://editorconfig.org/>`_.

Expand Down
2 changes: 1 addition & 1 deletion docs/devguide/workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To set up a developer environment
.. code-block:: bash
cd path/to/compas
pip install -r requirements-dev.txt
pip install -e ".[dev]"
4. Make sure all tests pass and the code is free of lint:

Expand Down

0 comments on commit a8c6c49

Please sign in to comment.