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

10
doc/DESIGN.org
View file

@ -4,7 +4,8 @@ note: this doc is in progress
- interoperable
This is the main motivation and [[file::README.org::#why][why]] I created HPI in the first place.
# note: this link doesnt work in org, but does for the github preview
This is the main motivation and [[file:../README.org#why][why]] I created HPI in the first place.
Ideally it should be possible to hook into anything you can imagine -- regardless the database/programming language/etc.
@ -31,12 +32,12 @@ note: this doc is in progress
Data is inherently messy, and it's inevitable to get parsing errors and missing fields now and then.
I'm trying to combat this with [[https://beepb00p.xyz/mypy-error-handling.html][mypy assisted error handlign]],
I'm trying to combat this with [[https://beepb00p.xyz/mypy-error-handling.html][mypy assisted error handling]],
so you are aware of errors, but still can work with the 'good' subset of data.
- robust
The code is extensively covered with tests & mypy to make sure it doesn't rot.
The code is extensively covered with tests & ~mypy~ to make sure it doesn't rot.
I also try to keep everything as backwards compatible as possible.
- (almost) no magic
@ -49,7 +50,6 @@ note: this doc is in progress
- use mature tools like =pip= or =mypy=
* other docs
- [[file:CONFIGURING.org][some decisions around HPI configuration 'system']]
- [[file:MODULE_DESIGN.org][some thoughts on the modules, their design, and adding new ones]]