tl;dr: Wrote an API doc helper for Observable, check it out, let me know whatcha think.
I’ve started to write my own library notebook and included a helper that is supposed to make documenting and testing functions a breeze. Implementation goals:
- Require minimal configuration (i.e. sane defaults)
- Be flexible, handle a broad range of use cases (i.e. allow to override stuff)
- Don’t impose a documentation style (e.g. don’t force jsdoc)
- Provide a minimal testing framework
While the library is still very much a work in progress, the helper itself is in a state that I feel comfortable sharing. I’d appreciate it if you took the time to play around with it and share your impressions. Please also let me know if you believe that the API or documentation is missing anything critical.