From 28fa3ffacf953749e87c396511cb266989068545 Mon Sep 17 00:00:00 2001 From: Bernd Hahnebach Date: Fri, 6 Sep 2019 20:57:28 +0200 Subject: [PATCH] FEM: rename code formatting to coding conventions --- src/Mod/Fem/CMakeLists.txt | 2 +- src/Mod/Fem/{codeformating.md => coding_conventions.md} | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) rename src/Mod/Fem/{codeformating.md => coding_conventions.md} (96%) diff --git a/src/Mod/Fem/CMakeLists.txt b/src/Mod/Fem/CMakeLists.txt index e07a35c38d..46322bd6c5 100755 --- a/src/Mod/Fem/CMakeLists.txt +++ b/src/Mod/Fem/CMakeLists.txt @@ -20,7 +20,7 @@ endif(BUILD_GUI) # Python non Gui packages and modules SET(FemScripts_SRCS - codeformating.md + coding_conventions.md Init.py InitGui.py ObjectsFem.py diff --git a/src/Mod/Fem/codeformating.md b/src/Mod/Fem/coding_conventions.md similarity index 96% rename from src/Mod/Fem/codeformating.md rename to src/Mod/Fem/coding_conventions.md index 65a3c14b08..55850bf156 100644 --- a/src/Mod/Fem/codeformating.md +++ b/src/Mod/Fem/coding_conventions.md @@ -1,4 +1,4 @@ -# FEM coding rules +# FEM coding_conventions - These coding rules apply to FEM module code only. Other modules or the base system may use different coding rules especially in naming policy of Python. ## Python and C++ @@ -9,7 +9,7 @@ - no trailing white spaces ## Python -#### Code formating +#### Code formatting - except W503 all Python code is pep8 compliant - maximal line length is 100 - double quotes as string identifier @@ -22,7 +22,7 @@ - Function expected to return a value should indicate what is expected, so is_mesh_valid is a good name, but check_mesh is not a good name - Class names, methode names and variable that are locally and not supposed to be used for scripting should start with underscore like _MyInternalClass -### Python code formating tools +### Python code formatting tools - flake8 - in source code directory on Linux shell ~~~