Skip to content

Commit 5fdb993

Browse files
committed
Allow over 80 chars-long lines in Python scripts.
1 parent 3398c06 commit 5fdb993

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

.pep8speaks.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
pycodestyle:
2+
max-line-length: 99

docs/manual/developer_guide.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -917,3 +917,13 @@ Check out the various `ctest` options to perform specific testing, you can rerun
917917
Tests are added using the add_test cmake call. Each test should finish with a 0 exit-code in case everything went well and a non-zero if something failed. Output (both stdout and stderr) are collected by ctest and stored in logs or displayed. Make sure you never hard-code a path to any tool when doing testing (or anything really) in the cmake code. Always use configuration to find all the paths and then use the respective variable.
918918

919919
See some of the existing testing code in `cmake/SSGCommon.cmake`.
920+
921+
=== Contribution to infrastructure code
922+
923+
The SSG build and templating system is mostly written in Python.
924+
925+
==== Python
926+
927+
* The common pattern is to dynamically add the `shared/modules` to the import path. The `ssgcommon` module has many useful utility functions and predefined constants. See scripts at `shared/utils` as an example of this practice.
928+
* Follow the link:https://www.python.org/dev/peps/pep-0008/[PEP8 standard].
929+
* Try to keep most of your lines length under 80 characters. Although the 99 character limit is within link:https://www.python.org/dev/peps/pep-0008/#maximum-line-length[PEP8 requirements], there is no reason for most lines to be that long.

0 commit comments

Comments
 (0)