From 3ccd0fcd4c6b88d9221ffba91d2269fcc819f199 Mon Sep 17 00:00:00 2001 From: Anders Einar Hilden Date: Wed, 2 Aug 2023 18:22:44 +0200 Subject: [PATCH] chg: [doc] Fix python naming swap (based on example and practice) and stray whitespace. --- CODINGSTYLE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CODINGSTYLE.md b/CODINGSTYLE.md index 2c9f26679ab..29351d34d51 100644 --- a/CODINGSTYLE.md +++ b/CODINGSTYLE.md @@ -6,11 +6,11 @@ Maintaining proper coding style is very important for any large software project - It allows others (as well as the future you!) to easily understand fragments of code and what they were supposed to do, and thus makes it easier to later extend them with newer functionality or bug fixes - It allows others to easily review the code and catch bugs - It provides for an aesthetically pleasing experience when one reads the code - + ## General typographic conventions - Maintain a maximum line length of 80 characters. Even though today’s monitors often are very wide and it’s often not a problem to have 120 characters displayed in an editor, maintaining shorter line lengths improves readability. It also allows others to have two parallel windows open, side by side, each with different parts of the source code. - Naming conventions: - - `ClassName`, + - `ClassName`, - `someVariable`, `someFunction`, `someArgument` - Maintain a decent amount of horizontal spacing, e.g. add a space after `if` or before `{` in PHP, Python, JavaScript, and similar in other languages. Whether and where to also use spaces within expressions, such as `(y*4+8)` vs. `(y * 4 + 8)` is left to the developer’s judgment. Do not put spaces immediately after or before the brackets in expressions, so avoid constructs like this: `if ( condition )` and use ones like this: `if (condition)` instead. - Use descriptive names for variables and functions. At a time when most editors have auto-completion features, there is no excuse for using short variable names. @@ -25,7 +25,7 @@ Maintaining proper coding style is very important for any large software project ## File naming conventions - Never use spaces within file names - **PHP:** Write file names in title case ,e.g. `AttachmentTool.php` -- **Python:** Write file names with small letters, use a dash to separate words, rather than underscores, e.g. `load_warninglists.py` +- **Python:** Write file names with small letters, use an underscore to separate words, rather than dashes, e.g. `load_warninglists.py` - **JavaScript:** Write file names with small letters, use dashes to separate words, rather than underscores, e.g. `bootstrap-colorpicker.js` ## General programming style guidelines @@ -41,7 +41,7 @@ Maintaining proper coding style is very important for any large software project return style; } - In production code, there should be little to no commented or disabled code fragments. Do not use comments to disable code fragments, unless you need to. But generally, there is little excuse to keep old, unused code fragments in the code. Instead, use the functionality provided by the source code management system, such as git. For example, create a special branch for storing the old, unused code – this way you will always be able to merge this code into upstream in the future. -- Try not to hardcode values in the code. +- Try not to hardcode values in the code. ## Commit message guidelines