Skip to content

Commit

Permalink
FEM: small changes in coding conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
berndhahnebach committed Sep 18, 2019
1 parent a94448d commit 5c54af1
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions src/Mod/Fem/coding_conventions.md
Expand Up @@ -2,7 +2,16 @@
- 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.


## Spelling
- Be mindful of spelling. Spell checks are quite often neglected.
- [codespell]((https://github.com/codespell-project/codespell#updating) could be used

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

## Python and C++
#### Code formatting
- All files should have a license header
- Unix line endings are preferred
- never use mixed line endings on one file
Expand Down Expand Up @@ -52,11 +61,3 @@ find src/Mod/Fem/ -name "*\.py" | grep -v InitGui.py | xargs -I [] flake8 --igno
## C++
### Naming policy
- CamelCase names

## Spelling
- Be mindful of spelling. Spell checks are quite often neglected.
- [codespell]((https://github.com/codespell-project/codespell#updating) could be used

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

0 comments on commit 5c54af1

Please sign in to comment.