Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated style file

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2019-11-03 18:06:24 +01:00
parent b303eb6539
commit be7b69dc9a
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/markdown/style.md
+4 -2
View File
@@ -7,10 +7,12 @@ The source code of novelWriter broadly follows the style guide [PEP8](https://ww
* Methods are camelCase, not underscore based. * Methods are camelCase, not underscore based.
The reason is partially because of the maintainers personal preference, and partially because that is what Qt5 and PyQt5 uses. The reason is partially because of the maintainers personal preference, and partially because that is what Qt5 and PyQt5 uses.
The maintainer generally, across multiple programming languages, uses underscores for defining namespaces. The maintainer generally, across multiple programming languages, uses underscores for defining namespaces.
* The maximum length of a code line is 100 characters, not 79. * The maximum length of a code line is 99 characters, not 79.
The reason for this is that novelWriter is almost entirely made up of classes, meaning nearly all lines of code already have 8 leading spaces. The reason for this is that novelWriter is almost entirely made up of classes, meaning nearly all lines of code already have 8 leading spaces.
A 79 character limitation is too strict, and causes too many wrapped lines. A 79 character limitation is too strict, and causes too many wrapped lines.
100 characters is suitable for GitHub diff readability, and therefore the preferred limit. 99 characters is suitable for GitHub diff readability, and therefore the preferred limit.
It is also permitted under PEP8 as the maximum.
Comments and docstrings should comply with the 72 character limit.
* Aligning code with additional spaces is acceptable in those cases where it improves readability. * Aligning code with additional spaces is acceptable in those cases where it improves readability.
Otherwise, the PEP8 standard should be applied. Otherwise, the PEP8 standard should be applied.