There are folders in Potku with the same name which also contain files sharing same names. For example there are two files named "_tofehistogram.py" and both are in folders called "measurement" . Often times these files call classes, functions and parameters from each other which can and probably will cause confusion.
The solution to help clear some of the present and future confusion is to add a docstring in the beginning of the file with a brief description on what the script does. This would in my opinion help to quickly see what the script actually does and how it fits in the rest of the code base. Priority would be to add the description to files under folders with the same name, especially to files with the same name.
This obviously requires that the description on what the code does has to be made by someone who truly understands what the code does. The description also cannot be too specific to allow larger changes to be made within the script without the need to change the description. On the other hand the description cannot be too broad because then it wouldn't fulfill its purpose.
There are folders in Potku with the same name which also contain files sharing same names. For example there are two files named "_tofehistogram.py" and both are in folders called "measurement" . Often times these files call classes, functions and parameters from each other which can and probably will cause confusion.
The solution to help clear some of the present and future confusion is to add a docstring in the beginning of the file with a brief description on what the script does. This would in my opinion help to quickly see what the script actually does and how it fits in the rest of the code base. Priority would be to add the description to files under folders with the same name, especially to files with the same name.
This obviously requires that the description on what the code does has to be made by someone who truly understands what the code does. The description also cannot be too specific to allow larger changes to be made within the script without the need to change the description. On the other hand the description cannot be too broad because then it wouldn't fulfill its purpose.