cefn / Adafruit_Micropython_Blinka

MIT License
3 stars 0 forks source link

Documentation (nearly) absent #3

Open cefn opened 6 years ago

cefn commented 6 years ago

The source code is minimally documented at present, and only commented where arcane. Documentation already exists for the CircuitPython APIs which should apply to this source code too (which is rather the point - a reimplementation with the same semantics)

The documentation mirroring the CircuitPython docstrings has not yet been merged into the tree, while waiting to establish if the choice of implementation, performance tradeoffs are acceptable. Otherwise there would be a whole lot of copy-paste time invested against code which is due to be retired/replaced. Since the docstrings are already there, this is a future automated or manual task which is less important than proving the functionality.