In the interest of future maintainability, we need to augment the documentation/comments within our code, esp. in htn.clj.
For each non-trivial (and relevant) function, there should be have a combination of doc-string and comments that clearly state:
the purpose of the function (if not obvious in the fn name)
the function arguments (if not clearly named)
the return value
Also, any multiple-page-length function definitions (e.g., construct-hem-plan-map) should have a few comments interspersed, providing guidance to the reader.
Currently about half of the functions in htn.clj don't meet these objectives.
In the interest of future maintainability, we need to augment the documentation/comments within our code, esp. in htn.clj.
For each non-trivial (and relevant) function, there should be have a combination of doc-string and comments that clearly state:
Also, any multiple-page-length function definitions (e.g., construct-hem-plan-map) should have a few comments interspersed, providing guidance to the reader.
Currently about half of the functions in htn.clj don't meet these objectives.