mirror
/
client_golang
mirror of https://github.com/prometheus/client_golang.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Improve doc comment for Describe.

This commit is contained in:
Bjoern Rabenstein 2015-01-13 16:52:42 +01:00
parent 159e96f6c7
commit dd4e57186a
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
prometheus/collector.go
View File

@ -33,8 +33,9 @@ type Collector interface {
// duplicate descriptors. Those duplicates are simply ignored. However, // duplicate descriptors. Those duplicates are simply ignored. However,
// two different Collectors must not send duplicate descriptors.) This // two different Collectors must not send duplicate descriptors.) This
// method idempotently sends the same descriptors throughout the // method idempotently sends the same descriptors throughout the
// lifetime of the Collector. A Collector unable to describe itself must // lifetime of the Collector. If a Collector encounters an error while
// send an invalid descriptor (created with NewInvalidDesc). // executing this method, it must send an invalid descriptor (created
// with NewInvalidDesc) to signal the error to the registry.
Describe(chan<- *Desc) Describe(chan<- *Desc)
// Collect is called by Prometheus when collecting metrics. The // Collect is called by Prometheus when collecting metrics. The
// implementation sends each collected metric via the provided channel // implementation sends each collected metric via the provided channel