pweygoldt/projecthowto
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

merge into: pweygoldt:main
Branches Tags
pweygoldt:main
pweygoldt:structure
...
pull from: pweygoldt:structure
Branches Tags
pweygoldt:structure
pweygoldt:main

2 Commits
main ... structure

Author SHA1 Message Date
wendtalexander
75326daa85 [code] adding Documentation 2024-10-19 09:37:02 +02:00
wendtalexander
790b584d49 [code] testing 2024-10-19 09:24:30 +02:00
1 changed files with 7 additions and 0 deletions
Show Stats Expand all files Collapse all files

7
code/README.md
View File

@ -37,5 +37,12 @@ if __name__ == "__main__":
- Plotting scripts should start with plot, so that one can create a bash script for that executes all plot* scripts - Plotting scripts should start with plot, so that one can create a bash script for that executes all plot* scripts
- If you use a directory for managing specific task, in python it is called a module, you neeed a __init__.py file in the directory more in [packagehowto](https://whale.am28.uni-tuebingen.de/git/pweygoldt/packagehowto) - If you use a directory for managing specific task, in python it is called a module, you neeed a __init__.py file in the directory more in [packagehowto](https://whale.am28.uni-tuebingen.de/git/pweygoldt/packagehowto)
# Naming conventions
- Use snake_case for functions and variables
# Documentation
- Use docstrings for all functions and classes