From 27cb54009b57c1938f7ff97026c8b35c1688233f Mon Sep 17 00:00:00 2001 From: Bernd Hahnebach Date: Fri, 6 Sep 2019 07:58:00 +0200 Subject: [PATCH] Update codeformating.md --- src/Mod/Fem/codeformating.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Mod/Fem/codeformating.md b/src/Mod/Fem/codeformating.md index 8cb4b4a549..65a3c14b08 100644 --- a/src/Mod/Fem/codeformating.md +++ b/src/Mod/Fem/codeformating.md @@ -20,15 +20,15 @@ - snake_case_names - ClassNames, variable_names_without_capitals and CONSTANTS_USE_CAPITALS, functions_without_capitals - 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 and file names that are not supposed to be used for scripting should start with underscore like _MyInternalClass +- 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 - flake8 - in source code directory on Linux shell - ''' - find src/Mod/Fem/ -name "*\.py" | grep -v InitGui.py | xargs -I [] flake8 --ignore=E266,W503 --max-line-length=100 [] - ''' - +~~~ +find src/Mod/Fem/ -name "*\.py" | grep -v InitGui.py | xargs -I [] flake8 --ignore=E266,W503 --max-line-length=100 [] +~~~ + - www.lgtm.com - TODO: check pylint - automatic code formater will not be used for existant code @@ -41,6 +41,6 @@ ## Spelling - Take care on spelling. Quit often it is ignored to check for missspelling. - codespelling could be used -''' +~~~ codespell -q 3 -L aci,aline,alledges,als,ang,beginn,behaviour,bloaded,calculater,cancelled,cancelling,cas,cascade,centimetre,childs,colour,colours,currenty,doubleclick,dum,eiter,elemente,feld,freez,iff,indicies,initialisation,initialise,initialised,initialises,initialisiert,kilometre,lod,mantatory,methode,metres,millimetre,modell,nd,noe,normale,normaly,nto,numer,oder,ot,pres,programm,que,recurrance,rougly,seperator,serie,sinc,strack,substraction,te,thist,thru,tread,vertexes,uint,unter,whitespaces -S *.ts,*.po src/Mod/Fem -''' +~~~