Skip to content

Commit b06cd5a

Browse files
Fix typos
1 parent 8c83677 commit b06cd5a

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

Sources/FuturedArchitecture/Architecture/Alert/AlertModel.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import SwiftUI
44
///
55
/// ## Overview
66
///
7-
/// It wrappes the native `alert(_:isPresented:presenting:actions:message:)`, but you show an alert in different way by using the `defaultAlert(model:)` view modifier,
7+
/// It wraps the native `alert(_:isPresented:presenting:actions:message:)`, but you show an alert in different way by using the `defaultAlert(model:)` view modifier,
88
/// which then appears whenever the bound `model` value is not `nil` value.
99
/// Alert model contains two actions: `primaryAction` and `secondaryAction`, which are then represented as SwiftUI Button
1010
/// If both values are nil, system presents alert with standard "OK" button and given `title` and `message`

Sources/FuturedArchitecture/Architecture/Coordinator.swift

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import SwiftUI
22

3-
/// This architecture is modelled around the concept of *Flow Coordinators*. You might think about
3+
/// This architecture is modeled around the concept of *Flow Coordinators*. You might think about
44
/// *flow coordinator* as a "view model for container view." For example, whereas data model of
55
/// a Table View is stored in a *component model*, data model of ``SwiftUI.TabView`` and ``SwiftUI.NavigationStack``
66
/// is stored in an instance conforming to `Coordinator`.
77
///
88
/// This base `protocol` contains set of common requirements for all coordinators. Other protocols
9-
/// tailored to specific Containers are provided aswell.
9+
/// tailored to specific Containers are provided as well.
1010
public protocol Coordinator: ObservableObject {
1111
/// Type used to represent the state of the container, i.e. which child-components should be presented.
1212
associatedtype Destination: Hashable & Identifiable
@@ -17,7 +17,7 @@ public protocol Coordinator: ObservableObject {
1717

1818
/// `rootView` returns the coordinator's main view.
1919
/// - Note: It is common pattern to provide a default "destination" view as the body of the *container* instead of
20-
/// ``SwiftUI.EmptyView``. If you do so, remeber to always capture the `instance` of the *coordinator* weakly!
20+
/// ``SwiftUI.EmptyView``. If you do so, remember to always capture the `instance` of the *coordinator* weakly!
2121
/// - Warning: Maintain its purity by defining only the view, without added logic or modifiers.
2222
/// If logic or modifiers are needed, encapsulate them in a separate view that can accommodate necessary dependencies.
2323
/// Skipping this recommendation may prevent UI updates when changing `@Published` properties, as `rootView` is static.
@@ -74,8 +74,8 @@ public extension Coordinator {
7474

7575
/// `TabCoordinator` provides additional requirements for the use with ``SwiftUI.TabView``.
7676
/// This *coordinator* is ment to have ``TabViewFlow`` as the Root view.
77-
/// - Experiment: This API is in preview and subjet to change.
78-
/// - Todo: ``SwiftUI.TabView`` requires internal state, which is forbiddden as per
77+
/// - Experiment: This API is in preview and subject to change.
78+
/// - Todo: ``SwiftUI.TabView`` requires internal state, which is forbidden as per
7979
/// documentation of ``Coordinator.rootView(with:)``. Also, the API introduces `Tab` type
8080
/// which is essentially duplication of `Destination`. Consider, how the API limits the use of tabs.
8181
public protocol TabCoordinator: Coordinator {
@@ -90,7 +90,7 @@ public protocol TabCoordinator: Coordinator {
9090
///
9191
/// - ToDo: Create a template for this coordinator.
9292
public protocol NavigationStackCoordinator: Coordinator {
93-
/// Property modelling the Views currently placed on stack.
93+
/// Property modeling the Views currently placed on stack.
9494
@MainActor
9595
var path: [Destination] { get set }
9696
}
@@ -111,7 +111,7 @@ public extension NavigationStackCoordinator {
111111
}
112112

113113
/// Convenience function used to remove all views from the stack, until the provided destination.
114-
/// - Parameter destination: Destination to be reached. If nil is passed, or such destionation
114+
/// - Parameter destination: Destination to be reached. If nil is passed, or such destination
115115
/// is not currently on the stack, all views are removed.
116116
/// - Experiment: This API is in preview and subject to change.
117117
func pop(to destination: Destination) {

Sources/FuturedArchitecture/Architecture/DataCache.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import Foundation
1010
/// only via provided `update` methods. As a general rule, value types should
1111
/// be used as a `Model`.
1212
///
13-
/// - Experiment: This API is in preview and subjet to change.
14-
/// - ToDo: How the `DataCache` may interact with persistance such as
13+
/// - Experiment: This API is in preview and subject to change.
14+
/// - ToDo: How the `DataCache` may interact with persistence such as
1515
/// `CoreData` or `SwiftData` is an open question and subject of further
1616
/// research.
1717
public actor DataCache<Model: Equatable> {
@@ -34,7 +34,7 @@ public actor DataCache<Model: Equatable> {
3434
/// Atomically update one variable.
3535
///
3636
/// - ToDo: Investigate whether we can use variadic generics to improve the API.
37-
/// No change is emmited when the value is the same.
37+
/// No change is emitted when the value is the same.
3838
@inlinable
3939
public func update<T: Equatable>(_ keyPath: WritableKeyPath<Model, T>, with value: T) {
4040
guard value != self.value[keyPath: keyPath] else { return }

Sources/FuturedArchitecture/Architecture/TabViewFlow.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import SwiftUI
22

33
/// The `TabViewFlow` encapsulates the ``SwiftUI.TabView`` and binds it to the
44
/// variables and callbacks of the ``TabCoordinator`` which is retains as a ``SwiftUI.StateObject``.
5-
/// - Experiment: This API is in preview and subjet to change.
5+
/// - Experiment: This API is in preview and subject to change.
66
public struct TabViewFlow<Coordinator: TabCoordinator, Content: View>: View {
77
@StateObject private var coordinator: Coordinator
88
@ViewBuilder private let content: () -> Content

Sources/FuturedHelpers/Helpers/SceneDelegate.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ extension View {
3636
/// - Parameter sceneDelegate: The SceneDelegate to set.
3737
/// - Description:
3838
/// In the main app root view call this modifier and pass the SceneDelegate. You need to specify the AppSceneDelegate which conforms to the UIWindowSceneDelegate.
39-
/// This is necessary because the SceneDelegate is accessible in SwiftUI only via EnviromentObject.
39+
/// This is necessary because the SceneDelegate is accessible in SwiftUI only via EnvironmentObject.
4040
public func set<T: AppSceneDelegate>(appSceneDelegateClass: T.Type, sceneDelegate: SceneDelegate) -> some View {
4141
modifier(SceneDelegateWrapperViewModifier<T>(delegate: sceneDelegate))
4242
}

0 commit comments

Comments
 (0)