Data types used in metric documentation.
A metric may be one of the following data types...
An integer that can only increase.
A numeric value that can be written without a fractional component. May increase or decrease.
A numeric value which may have a fractional component (i.e., decimals).
A numeric value having base 2.
A numeric value having base 8.
A value having base 16.
A unitless value on the interval [0,1].
A value which is a measure of time, having units such as milliseconds, seconds, days, etc.
A sequence of character values.
===
To contribute to the data-type documentation, see the contributing guide. Any updates to the documentation should be tagged.
$ git tag -a <major.minor.patch> -m "[UPDATE] version."
$ git push origin <major.minor.patch>Use semantic versioning (semvar) for communicating versions.
- Any new data types should be communicated as
minorupdates. - Any corrections/value modifications should be
patches. - Any documentation restructuring (changing field names, removing fields, etc) should be communicated as a
majorupdate.
===
The documentation is stored as JSON, a lightweight data-interchange format. Many languages provide JSON support: JavaScript, Python, Go, PHP, Java, Haskell, and others.
You are free to use the JSON documentation, as is. Simply copy the file and use accordingly.
For those using package managers to manage dependencies, we provide package manager support, as outlined below.
The documentation is registered as a Bower package. Bower provides a straightforward means for managing dependencies.
In order to use Bower, you must first install Node.js and Git. Once the prerequisites are installed,
$ npm install -g bowerTo install the latest documentation,
$ bower install doc-metrix-data-typesBower will place the documentation in a bower_components/ directory within the current working directory.
To update to the latest documentation,
$ bower update doc-metrix-data-typesCopyright © 2014. NodePrime.