Rename handler and add documentation

hotwired · Mar 20, 2024 · 0bd17ba · 0bd17ba
1 parent e9d7ba3
commit 0bd17ba
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/Source/Turbo Navigator/Helpers/ErrorPresenter.swift b/Source/Turbo Navigator/Helpers/ErrorPresenter.swift
@@ -3,14 +3,22 @@ import SwiftUI
 public protocol ErrorPresenter: UIViewController {
     typealias Handler = () -> Void
 
-    func presentError(_ error: Error, handler: Handler?)
+    func presentError(_ error: Error, retryHandler: Handler?)
 }
 
 public extension ErrorPresenter {
-    func presentError(_ error: Error, handler: Handler?) {
+
+    /// Presents an error in a full screen view.
+    /// The error view will display a `Retry` button if `retryHandler != nil`.
+    /// Tapping `Retry` will call `retryHandler?()` then dismiss the error.
+    ///
+    /// - Parameters:
+    ///   - error: <#error description#>
+    ///   - retryHandler: <#retryHandler description#>
+    func presentError(_ error: Error, retryHandler: Handler?) {
         let errorView = ErrorView(error: error,
-                                  shouldShowRetryButton: (handler != nil)) { [unowned self] in
-            handler?()
+                                  shouldShowRetryButton: (retryHandler != nil)) { [unowned self] in
+            retryHandler?()
             self.removeErrorViewController()
         }
 

diff --git a/Source/Turbo Navigator/TurboNavigatorDelegate.swift b/Source/Turbo Navigator/TurboNavigatorDelegate.swift
@@ -46,7 +46,7 @@ public extension TurboNavigatorDelegate {
 
     func visitableDidFailRequest(_ visitable: Visitable, error: Error, retry: RetryBlock?) {
         if let errorPresenter = visitable as? ErrorPresenter {
-            errorPresenter.presentError(error, handler: retry)
+            errorPresenter.presentError(error, retryHandler: retry)
         }
     }