mirror
/
swift-metrics
mirror of https://github.com/apple/swift-metrics.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

define record() more explicitly that it is a "set the value" (#35) 

motivation: define record() more explicitly that it is a "set the value" operation as it seemed to be confusing when implementing or using the API.

changes: update API docs accordingly
This commit is contained in:
Konrad `ktoso` Malawski 2019-07-31 06:55:38 +09:00 committed by tomer doron
parent 25c2c17b45
commit e0ec4aea36
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Sources/CoreMetrics/Metrics.swift
View File

@ -135,6 +135,9 @@ public class Recorder {
/// Record a value.
///
/// Recording a value is meant to have "set" semantics, rather than "add" semantics.
/// This means that the value of this `Recorder` will match the passed in value, rather than accumulate and sum the values up.
///
/// - parameters:
/// - value: Value to record.
@inlinable
@ -144,6 +147,9 @@ public class Recorder {
/// Record a value.
///
/// Recording a value is meant to have "set" semantics, rather than "add" semantics.
/// This means that the value of this `Recorder` will match the passed in value, rather than accumulate and sum the values up.
///
/// - parameters:
/// - value: Value to record.
@inlinable