From b24e6b2fb32ea8446409baab9cfc581c61eacacf Mon Sep 17 00:00:00 2001 From: tomer doron Date: Thu, 7 Mar 2019 16:05:36 -0800 Subject: [PATCH] fixing typos motivation: documentation cleanup changes: fix various typos in method documentation --- Sources/CoreMetrics/Metrics.swift | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Sources/CoreMetrics/Metrics.swift b/Sources/CoreMetrics/Metrics.swift index 5e9604d..e312360 100644 --- a/Sources/CoreMetrics/Metrics.swift +++ b/Sources/CoreMetrics/Metrics.swift @@ -12,12 +12,12 @@ // //===----------------------------------------------------------------------===// -/// This is the Counter protocol a metrics library implements +/// This is the Counter protocol a metrics library implements. It must have reference semantics public protocol CounterHandler: AnyObject { func increment(_ value: DataType) } -// This is the user facing Counter API. It must have reference semantics, and its behviour depend ons the `CounterHandler` implementation +// This is the user facing Counter API. Its behavior depends on the `CounterHandler` implementation public class Counter: CounterHandler { @usableFromInline var handler: CounterHandler @@ -50,13 +50,13 @@ public extension Counter { } } -/// This is the Recorder protocol a metrics library implements +/// This is the Recorder protocol a metrics library implements. It must have reference semantics public protocol RecorderHandler: AnyObject { func record(_ value: DataType) func record(_ value: DataType) } -// This is the user facing Recorder API. It must have reference semantics, and its behviour depend ons the `RecorderHandler` implementation +// This is the user facing Recorder API. Its behavior depends on the `RecorderHandler` implementation public class Recorder: RecorderHandler { @usableFromInline var handler: RecorderHandler @@ -98,12 +98,12 @@ public class Gauge: Recorder { } } -// This is the Timer protocol a metrics library implements +// This is the Timer protocol a metrics library implements. It must have reference semantics public protocol TimerHandler: AnyObject { func recordNanoseconds(_ duration: Int64) } -// This is the user facing Timer API. It must have reference semantics, and its behviour depend ons the `RecorderHandler` implementation +// This is the user facing Timer API. Its behavior depends on the `RecorderHandler` implementation public class Timer: TimerHandler { @usableFromInline var handler: TimerHandler @@ -167,7 +167,7 @@ public protocol MetricsFactory { func makeTimer(label: String, dimensions: [(String, String)]) -> TimerHandler } -// This is the metrics system itself, it's mostly used set the type of the `MetricsFactory` implementation. +// This is the metrics system itself, it's mostly used set the type of the `MetricsFactory` implementation public enum MetricsSystem { fileprivate static let lock = ReadWriteLock() fileprivate static var _factory: MetricsFactory = NOOPMetricsHandler.instance