Repository navigation
Enhancement request: better documentation #528
Description
The documentation for this library is incomplete. It could really use some thorough API documentation. For example, what is a Registry? When does the collect method get called, and what is its contract?
Reacted by Leonard Shi, Asgoret, Michael Voelker, Maarten, Alex Tutea, szymanskim, Florian Ludwig, Liu Cao, Jonas Lindström, maybe-hello-world and 10 more
Activity
Asgoret commentedon Apr 5, 2020
Documentation is awful...I wrote function and client show anything else except my function and I can't understand why in console everything alright.
migueleliasweb commentedon May 19, 2020
It's kinda true. The examples are surprisingly shallow and if you need anything other than a simple
Gaugeusing the simplestart_http_serveryou're in for a rollercoaster ride. 😂tarrenj commentedon Nov 29, 2021
Oh man, I agree with this wholeheartedly!
zheng-guannan577 commentedon Nov 9, 2026
Hi, I'd like to improve the API docs for the core concepts. To keep the PR small, I'd start with the Registry docs — is that the right scope, or would you prefer a different starting point?