fz0x1/HPI
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add some documentation on module design (#160)

Browse source
This commit is contained in:
Sean Breckenridge 2021-04-11 08:53:43 -07:00 • committed by GitHub
parent f559e7cb89
commit c1b70cd90e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 177 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/MODULES.org
View file

@ -52,9 +52,11 @@ Some explanations:
This can be useful for modules that merge multiple data sources (for example, =my.twitter= or =my.github=)
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]].
- if the field has a default value, you can omit it from your private config altogether
For more thoughts on modules and their structure, see [[file:MODULE_DESIGN.org][MODULE_DESIGN]]
* Configs
The config snippets below are meant to be modified accordingly and *pasted into your private configuration*, e.g =$MY_CONFIG/my/config.py=.