I created some docstrings following your latest commits (I use Spyder's basic "create docstrings" tool). Formatted docstrings are probably a good step towards a more complete documentation later on and also help me in further discovering the workings of PyFVTool.
Minor cosmetic code edit: A colleague once explained to me that just raising a generic Exception should be avoided, and a more specific exception should be raised. This makes sense, since more information about the exact cause of the exception is then transmitted within the program.
simulkade
commented
1 year ago
I created some docstrings following your latest commits (I use Spyder's basic "create docstrings" tool). Formatted docstrings are probably a good step towards a more complete documentation later on and also help me in further discovering the workings of PyFVTool.
Minor cosmetic code edit: A colleague once explained to me that just raising a generic
Exceptionshould be avoided, and a more specific exception should be raised. This makes sense, since more information about the exact cause of the exception is then transmitted within the program.