add some documentation on module design

This commit is contained in:
Sean Breckenridge 2021-04-11 00:33:54 -07:00
parent f559e7cb89
commit 3378bc8e75
7 changed files with 171 additions and 43 deletions

View file

@ -53,6 +53,8 @@ Some explanations:
Typically, such variable will be passed to =get_files= to actually extract the list of real files to use. You can see usage examples [[https://github.com/karlicoss/HPI/blob/master/tests/get_files.py][here]].
For more thoughts on modules and their structure, see [[file:MODULE_DESIGN.org][MODULE_DESIGN.org]]
- if the field has a default value, you can omit it from your private config altogether
* Configs