Skip to content

Fix various misspellings #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 30, 2021
Merged

Fix various misspellings #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f51e80e
Fix various misspellings
rauhul Jul 29, 2021
ae03ef4
Merge branch 'master' into feature/spelling
MrLotU Jul 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Sources/Prometheus/MetricTypes/Gauge.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public class PromGauge<NumType: DoubleRepresentable, Labels: MetricLabels>: Prom
}
}

/// Sets the Gauge to the current unixtime in seconds
/// Sets the Gauge to the current unix-time in seconds
///
/// - Parameters:
/// - labels: Labels to attach to the value
Expand All @@ -84,7 +84,7 @@ public class PromGauge<NumType: DoubleRepresentable, Labels: MetricLabels>: Prom
/// Tracks in progress blocks of code or functions.
///
/// func someFunc() -> String { return "ABC" }
/// let newFunc = myGauge.trackInprogress(someFunc)
/// let newFunc = myGauge.trackInProgress(someFunc)
/// newFunc() // returns "ABC" and increments & decrements Gauge
///
/// - Parameters:
Expand Down
2 changes: 1 addition & 1 deletion Sources/Prometheus/MetricTypes/PromMetric.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ extension PromMetric {

/// Adding a prometheus instance to all metrics
internal protocol PrometheusHandled {
/// Promtheus client handling this metric
/// Prometheus client handling this metric
var prometheus: PrometheusClient? { get }
}

Expand Down
8 changes: 4 additions & 4 deletions Sources/Prometheus/Prometheus.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ public class PrometheusClient {
/// - type: The type the summary will observe
/// - name: Name of the summary
/// - helpText: Help text for the summary. Usually a short description
/// - quantiles: Quantiles to caluculate
/// - quantiles: Quantiles to calculate
/// - labels: Labels to give this summary. Can be left out to default to no labels
///
/// - Returns: Summary instance
Expand Down Expand Up @@ -269,7 +269,7 @@ public class PrometheusClient {
/// - type: The type the summary will observe
/// - name: Name of the summary
/// - helpText: Help text for the summary. Usually a short description
/// - quantiles: Quantiles to caluculate
/// - quantiles: Quantiles to calculate
///
/// - Returns: Summary instance
public func createSummary<T: Numeric>(
Expand All @@ -284,8 +284,8 @@ public class PrometheusClient {

/// Prometheus specific errors
public enum PrometheusError: Error {
/// Thrown when a user tries to retrive
/// a `PromtheusClient` from `MetricsSystem`
/// Thrown when a user tries to retrieve
/// a `PrometheusClient` from `MetricsSystem`
/// but there was no `PrometheusClient` bootstrapped
case prometheusFactoryNotBootstrapped(bootstrappedWith: String)
}
Expand Down
4 changes: 2 additions & 2 deletions Sources/Prometheus/PrometheusMetrics.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ public struct PrometheusLabelSanitizer: LabelSanitizer {
}

/// Defines the base for a bridge between PrometheusClient and swift-metrics.
/// Used by `SwiftMetrics.prometheus()` to get an instance of `PromtheusClient` from `MetricsSystem`
/// Used by `SwiftMetrics.prometheus()` to get an instance of `PrometheusClient` from `MetricsSystem`
///
/// Any custom implementation of `MetricsFactory` using `PrometheusClient` should conform to this implementation.
public protocol PrometheusWrappedMetricsFactory: MetricsFactory {
Expand Down Expand Up @@ -360,7 +360,7 @@ public struct DimensionLabels: MetricLabels {

/// Helper for dimensions
/// swift-metrics api doesn't allow setting buckets explicitly.
/// If default buckets don't fit, this Labels implementation is a nice default to create Prometheus metric types wtih
/// If default buckets don't fit, this Labels implementation is a nice default to create Prometheus metric types with
public struct DimensionHistogramLabels: HistogramLabels {
/// Bucket
public var le: String
Expand Down