david-cattermole
commented
4 years ago The documentation isn't perfect, but it's better than what it was.
These new changes are up on the documentation website too.
Closing for now.
Closed david-cattermole closed 4 years ago
david-cattermole
commented
4 years ago The documentation isn't perfect, but it's better than what it was.
These new changes are up on the documentation website too.
Closing for now.
Problem / Feature
The "compile" module usage, and the "SolverBase" usage is not well documented. Many functions/methods are missing doc-strings.
For example these files will likely need to have improved documentation:
If there are any obvious refactor we can make to improve the readability, and NOT change behavior we should do also do that. Any bugs found should be reported in a different issue and fixed separately.
Expected behavior: Behaviour of the tool should not change from changes to this issue.
Actual behavior: See above.
Software Versions
Only the current development version will be affected, however the documentation (not any refactoring) should be pushed into the current "master" documentation here.