Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarification between folders/files with the same name #258

Open
Huojuu opened this issue Mar 7, 2022 · 0 comments
Open

Clarification between folders/files with the same name #258

Huojuu opened this issue Mar 7, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@Huojuu
Copy link
Contributor

Huojuu commented Mar 7, 2022

There are folders in Potku with the same name which also contain files sharing same names. For example there are two files named "tofe_histogram.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.

@tpitkanen tpitkanen added the enhancement New feature or request label Mar 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants