client_python icon indicating copy to clipboard operation
client_python copied to clipboard

Enhancement request: better documentation

Open asomers opened this issue 5 years ago • 3 comments

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?

asomers avatar Mar 12 '20 14:03 asomers

Documentation is awful...I wrote function and client show anything else except my function and I can't understand why in console everything alright.

Asgoret avatar Apr 05 '20 13:04 Asgoret

It's kinda true. The examples are surprisingly shallow and if you need anything other than a simple Gauge using the simple start_http_server you're in for a rollercoaster ride. 😂

migueleliasweb avatar May 19 '20 00:05 migueleliasweb

Oh man, I agree with this wholeheartedly!

tarrenj avatar Nov 29 '21 20:11 tarrenj