client_golang/documentation.go

// Copyright (c) 2012, Matt T. Proud
// All rights reserved.
//
// Use of this source code is governed by a BSD-style license that can be found
// in the LICENSE file.

// registry.go provides a container for centralized exposition of metrics to
// their prospective consumers.
//
//  registry.Register("human_readable_metric_name", "metric docstring", map[string]string{"baseLabel": "baseLabelValue"}, metric)
package registry
Sundry cosmetic fixes across the board. - Comments are migrated from ``/* */`` to ``//`` per convention. - ``NewDefaultHistogram`` helper. - ``Registry.Handler`` and ``Registry.YieldExporter`` deprecation. - Cleanup of legacy import paths. - Updating examples to use acknowledged patterns. - Parameterizing the random parameter namespaces for ``examples/random/main.go``, which is useful for demoing population behaviors. 2013-02-12 05:36:06 +04:00			`// Copyright (c) 2012, Matt T. Proud`
			`// All rights reserved.`
			`//`
			`// Use of this source code is governed by a BSD-style license that can be found`
			`// in the LICENSE file.`
- Separate out the packages' files' documentation into a separate documentation file per package. - Provide better examples in the examples subdirectory. - Make the comments consistent in terms of using multi-line format for future-proofing. - Extract major constants out. 2012-05-24 22:02:44 +04:00
Sundry cosmetic fixes across the board. - Comments are migrated from ``/* */`` to ``//`` per convention. - ``NewDefaultHistogram`` helper. - ``Registry.Handler`` and ``Registry.YieldExporter`` deprecation. - Cleanup of legacy import paths. - Updating examples to use acknowledged patterns. - Parameterizing the random parameter namespaces for ``examples/random/main.go``, which is useful for demoing population behaviors. 2013-02-12 05:36:06 +04:00			`// registry.go provides a container for centralized exposition of metrics to`
			`// their prospective consumers.`
Fix documentation after reading via server. Examining the existing documentation over the standard Go documentation server revealed some serious formatting flaws. Everything should be readable now. 2013-02-18 08:09:21 +04:00			`//`
			`// registry.Register("human_readable_metric_name", "metric docstring", map[string]string{"baseLabel": "baseLabelValue"}, metric)`
- Separate out the packages' files' documentation into a separate documentation file per package. - Provide better examples in the examples subdirectory. - Make the comments consistent in terms of using multi-line format for future-proofing. - Extract major constants out. 2012-05-24 22:02:44 +04:00			`package registry`