FEM Python coding standard

[bernd]

would be cool to have all this in the wiki, including the latest list of the exclude words.

[bernd]

Since I only check in FEM I could create my own exclude word list?! Would you help here? We could minimize this list!

[Kunda1]

Since I only check in FEM I could create my own exclude word list?! Would you help here? We could minimize this list!

https://www.freecadweb.org/wiki/Codespell

Sure I can create a FEM specific list for you.

[Kunda1]

Code: Select all

codespell -q 2 -S *.ts,./coding_conventions.md  -L alle,childs,dof,dum,ist,methode,nd,normaly,uint,vertexes

[bernd]

git commit daefc7f

Code: Select all

$ codespell -q 2 -S *.ts  -L alle,childs,dof,dum,ist,methode,nd,normaly,uint,vertexes  src/Mod/Fem/
src/Mod/Fem/App/FemMesh.cpp:1138: Elemente  ==> Element, elements
src/Mod/Fem/App/FemMesh.cpp:1954: Elemente  ==> Element, elements
src/Mod/Fem/Gui/TaskFemConstraintDisplacement.cpp:93: freez  ==> frees, freeze
src/Mod/Fem/Gui/TaskFemConstraintDisplacement.cpp:325: freez  ==> frees, freeze
src/Mod/Fem/Gui/TaskFemConstraintDisplacement.h:86: freez  ==> frees, freeze
src/Mod/Fem/femsolver/writerbase.py:111: elemente  ==> element, elements
src/Mod/Fem/femsolver/calculix/solver.py:105: noe  ==> not, no, node, know, now
src/Mod/Fem/femsolver/calculix/solver.py:106: noe  ==> not, no, node, know, now
src/Mod/Fem/femsolver/z88/writer.py:127: elemente  ==> element, elements
src/Mod/Fem/femsolver/z88/writer.py:382: Programm  ==> Program
src/Mod/Fem/femobjects/_FemSolverCalculix.py:96: noe  ==> not, no, node, know, now
src/Mod/Fem/femobjects/_FemSolverCalculix.py:97: noe  ==> not, no, node, know, now
$ 

[bernd]

git commit 5e939be and git commit 866010f

but one strange happens ...

Code: Select all

codespell -q 2 -S *.ts  -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez,Programm  src/Mod/Fem/

although I add Programm it finds Programm as error

Code: Select all

$
$ codespell -q 2 -S *.ts  -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez,Programm  src/Mod/Fem/
src/Mod/Fem/femsolver/z88/writer.py:382: Programm  ==> Program
$ 

[Kunda1]

although I add Programm it finds Programm as error

Code: Select all

  -L WORDS, --ignore-words-list WORDS
                        Comma separated list of words to be ignored by
                        codespell. Words are case sensitive based on how they
                        are written in the dictionary file

most of the words in the dictionary file are lowercase. So just change it to 'programm' and you'll be fine

Edit: is programm the correct way to write it in Deutsche ?

[kkremitzki]

Yes, it's Programm with a capital P, auf Deutsch. It's one of the most common ways for a native-German-speaking person to give away that fact when they use English, along with accidentally switching "ist" for "is".

[ebrahim raeyat]

@bernd, when i type codespell -L:

Code: Select all

codespell: error: no such option: -L

[ebrahim raeyat]

for flake8 linter, i applied it on sublimtext IDE.