-
Notifications
You must be signed in to change notification settings - Fork 9
Internal Documentation
Just a start for standards, first draft from Russ Hensel, not really a member of team yet but seeking guidance.
I think that code through naming and structure should document itself as much as possible, but I do not think that this can eliminate all other documentation, so:
Based on inspection of about 10 module on 5/28/2023 doc strings are not generally present -- does this represent the desired standard?
Based on inspection of about 10 module on 5/28/2023 some, but not the majority of classes, are documented in the init method.
...
...
...
Black for formatting and ruff for linting as given in requirements file, A plan is to automate the process by using github actions soon,
Loggers
To get the working and happening to each and every script and processes, work under progress