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

21 lines
672 B
Go
Raw Normal View History

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.
- 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
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
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
//
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
// The utility package provides general purpose helpers to assist with this
// library.
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
//
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
// priority_queue.go provides a simple priority queue.
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
//
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
// priority_queue_test.go provides a test complement for the priority_queue.go
// module.
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
//
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
// test_helper.go provides a testing assistents for this package and its
// dependents.
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
//
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
// utility_test.go provides a test suite for all tests in the utility package
// hierarchy. It employs the gocheck framework for test scaffolding.
- 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 documentation