From 1bec4fcb1dbd27a26b628438354a2306d9fb7abf Mon Sep 17 00:00:00 2001 From: Varun Santhanam Date: Sun, 12 Jun 2022 10:29:03 -0700 Subject: [PATCH] Fix Typo in Documentation --- .../API/NetworkMonitor/NetworkMonitor+Combine.swift | 2 +- .../NetworkReachability.docc/GettingStarted.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Sources/NetworkReachability/API/NetworkMonitor/NetworkMonitor+Combine.swift b/Sources/NetworkReachability/API/NetworkMonitor/NetworkMonitor+Combine.swift index 040bd656..e74486a7 100644 --- a/Sources/NetworkReachability/API/NetworkMonitor/NetworkMonitor+Combine.swift +++ b/Sources/NetworkReachability/API/NetworkMonitor/NetworkMonitor+Combine.swift @@ -54,7 +54,7 @@ /// Use this function to observe network path updates using [Combine](https://developer.apple.com/documentation/combine) /// /// ```swift - /// let cancellable = NetworkMonitor.networkPathPublisher(requiringInterfaceType: [.wifi]) + /// let cancellable = NetworkMonitor.networkPathPublisher(requiringInterfaceType: .wifi) /// .map { path in /// path.status == .satisfied /// } diff --git a/Sources/NetworkReachability/NetworkReachability.docc/GettingStarted.md b/Sources/NetworkReachability/NetworkReachability.docc/GettingStarted.md index 354b9239..b80dd6ae 100644 --- a/Sources/NetworkReachability/NetworkReachability.docc/GettingStarted.md +++ b/Sources/NetworkReachability/NetworkReachability.docc/GettingStarted.md @@ -12,10 +12,10 @@ NetworkReachability consists of two main classes, ``NetworkMonitor`` and ``Reach These APIs are very similar, and can generally be used interchangeably. Like Apple's APIs, ``ReachabilityMonitor`` offers a synchronous & asynchronous APIs, and is capable of throwing errors. ``NetworkMonitor`` monitor is simpler and more powerful, but does not offer a reliable synchronous API. -| API | Single Value | Observing Values | Throws Errors | Minimum OS | -| ------------------ | ------------ | ----------------- | ------------- | --------------------------------------- | -| ``NetworkMonitor`` | Async | Async | No | iOS 12, macOS 10.14, watchOS 5, tvOS 12 | -| ``Reachability`` | Sync | Async | Yes | iOS 11, macOS 10.13, watchOS 4, tvOS 11 | +| API | Single Value | Observing Values | Throws Errors | Minimum OS | +| ------------------------- | ------------ | ----------------- | ------------- | --------------------------------------- | +| ``NetworkMonitor`` | Async | Async | No | iOS 12, macOS 10.14, watchOS 5, tvOS 12 | +| ``ReachabilityMonitor`` | Sync | Async | Yes | iOS 11, macOS 10.13, watchOS 4, tvOS 11 | I recommend that you use ``NetworkMonitor`` as it both simpler and more robust, unless you need to target iOS 11 or you absolutely need a synchronous API.