Skip to content

Commit 80c8edb

Browse files
ktosoyim-lee
andauthored
Apply suggestions from code review
Co-authored-by: Yim Lee <[email protected]>
1 parent 0b86c69 commit 80c8edb

File tree

5 files changed

+6
-7
lines changed

5 files changed

+6
-7
lines changed

Sources/MetricsTestUtils/Docs.docc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import Metrics
1313
import MetricsTestUtils
1414
```
1515

16-
First, bootstrap the metrics system in your test using the `bootstrapInternal` method which allows overriding existing bootstraps:
16+
Then bootstrap the metrics system in your test using the `bootstrapInternal` method which allows overriding existing bootstraps:
1717

1818
```swift
1919
final class SWIMNIOMetricsTests: XCTestCase {

Sources/MetricsTestUtils/TestMetrics.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ extension TestMetrics {
158158
/// - Parameters:
159159
/// - label: the expected label the looked for metric should have
160160
/// - dimensions: the expected dimensions the looked for metric should have
161-
/// - Returns: the underlying ``TestMetric``
161+
/// - Returns: the underlying ``TestCounter``
162162
/// - Throws: when no such test metric was present
163163
public func expectCounter(_ label: String, _ dimensions: [(String, String)] = []) throws -> TestCounter {
164164
let maybeItem = self.lock.withLock {

Sources/SystemMetrics/Docs.docc/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ This makes the System Metrics API available. This adds a new method to `MetricsS
2727

2828
`bootstrapWithSystemMetrics` takes a `SystemMetrics.Configuration` object to configure the system metrics. The config has the following properties:
2929

30-
- interval: The interval at which SystemMetrics are being calculated & exported.
31-
- dataProvider: A closure returing `SystemMetrics.Data?`. When `nil` no metrics are exported (the default on non-linux platforms). `SystemMetrics.Data` holds all the values mentioned above.
30+
- interval: The interval at which `SystemMetrics` are being calculated & exported.
31+
- dataProvider: A closure returning `SystemMetrics.Data?`. When `nil`, no metrics are exported (the default on non-Linux platforms). `SystemMetrics.Data` holds all the values mentioned above.
3232
- labels: `SystemMetrics.Labels` hold a string label for each of the above mentioned metrics that will be used for the metric labels, along with a prefix that will be used for all above mentioned metrics.
3333

3434
Swift Metrics backend implementations are encouraged to provide static extensions to `SystemMetrics.Configuration` that fit the requirements of their specific backends. For example:

docker/docker-compose.2004.56.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ services:
1010
swift_version: "5.6"
1111

1212
test:
13-
image: swift-metrics:20.04-5.6
13+
image: swift-metrics:20.04-5.6
1414
environment:
1515
- FORCE_TEST_DISCOVERY=--enable-test-discovery
1616
#- SANITIZER_ARG=--sanitize=thread

docker/docker-compose.2004.57.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ services:
66
image: swift-metrics:20.04-5.7
77
build:
88
args:
9-
ubuntu_version: "focal"
10-
swift_version: "5.7"
9+
base_image: "swiftlang/swift:nightly-5.7-focal"
1110

1211
test:
1312
image: swift-metrics:20.04-5.7

0 commit comments

Comments
 (0)