Cleanup (#1107)

Author: mluisbrown

Sources/ComposableArchitecture/Effect.swift

@@ -170,8 +170,7 @@ extension Effect {
   /// Turns any `SignalProducer` into an ``Effect`` that cannot fail by wrapping its output and failure into
   /// result and then applying passed in function to it.
   ///
-  /// This is a convenience operator for writing ``Effect/catchToEffect()`` followed by a
-  /// ``Effect/map(_:)``.
+  /// This is a convenience operator for writing ``Effect/catchToEffect()`` followed by `map`.
   ///
   /// ```swift
   /// case .buttonTapped:

Sources/ComposableArchitecture/Store.swift

@@ -245,6 +245,7 @@ public final class Store<State, Action> {
   /// ```
   ///
   /// The login view holds onto a store of this domain:
+  ///
   /// ```swift
   /// struct LoginView: View {
   ///   let store: Store<LoginState, LoginAction>
@@ -361,6 +362,8 @@ public final class Store<State, Action> {
 
   /// Scopes the store to one that exposes local state.
   ///
+  /// A version of ``scope(state:action:)`` that leaves the action type unchanged.
+  ///
   /// - Parameter toLocalState: A function that transforms `State` into `LocalState`.
   /// - Returns: A new store with its domain (state and action) transformed.
   public func scope<LocalState>(

Sources/ComposableArchitecture/TestSupport/TestStore.swift

@@ -43,7 +43,6 @@
   /// struct CounterState {
   ///   var count = 0
   /// }
-  ///
   /// enum CounterAction: Equatable {
   ///   case decrementButtonTapped
   ///   case incrementButtonTapped
@@ -68,12 +67,12 @@
   /// class CounterTests: XCTestCase {
   ///   func testCounter() {
   ///     let store = TestStore(
-  ///       initialState: .init(count: 0),     // GIVEN counter state of 0
+  ///       initialState: .init(count: 0),      // Given a counter state of 0
   ///       reducer: counterReducer,
   ///       environment: ()
   ///     )
-  ///     store.send(.incrementButtonTapped) { // WHEN the increment button is tapped
-  ///       $0.count = 1                       // THEN the count should be 1
+  ///     store.send(.incrementButtonTapped) {  // When the increment button is tapped
+  ///       $0.count = 1                        // Then the count should be 1
   ///     }
   ///   }
   /// }
@@ -84,8 +83,8 @@
   /// to match the state after the action was sent. In this case the `count` field changes to `1`.
   ///
   /// For a more complex example, consider the following bare-bones search feature that uses the
-  /// ``Effect/debounce(id:for:scheduler:)`` operator to wait for the user to stop typing
-  /// before making a network request:
+  /// ``Effect/debounce(id:for:scheduler:)-76yye`` operator to wait for the user to stop
+  /// typing before making a network request:
   ///
   /// ```swift
   /// struct SearchState: Equatable {
@@ -176,7 +175,7 @@
     private var inFlightEffects: Set<LongLivingEffect> = []
     var receivedActions: [(action: Action, state: State)] = []
     private let reducer: Reducer<State, Action, Environment>
-    private var snapshotState: State
+    private var state: State
     private var store: Store<State, TestAction>!
     private let toLocalState: (State) -> LocalState
 
@@ -194,7 +193,7 @@
       self.fromLocalAction = fromLocalAction
       self.line = line
       self.reducer = reducer
-      self.snapshotState = initialState
+      self.state = initialState
       self.toLocalState = toLocalState
 
       self.store = Store(
@@ -204,7 +203,7 @@
           switch action.origin {
           case let .send(localAction):
             effects = self.reducer.run(&state, self.fromLocalAction(localAction), self.environment)
-            self.snapshotState = state
+            self.state = state
 
           case let .receive(action):
             effects = self.reducer.run(&state, action, self.environment)
@@ -352,7 +351,7 @@
           file: file, line: line
         )
       }
-      var expectedState = self.toLocalState(self.snapshotState)
+      var expectedState = self.toLocalState(self.state)
       self.store.send(.init(origin: .send(action), file: file, line: line))
       do {
         try self.expectedStateShouldChange(
@@ -366,7 +365,7 @@
       }
       self.expectedStateShouldMatch(
         expected: expectedState,
-        actual: self.toLocalState(self.snapshotState),
+        actual: self.toLocalState(self.state),
         file: file,
         line: line
       )
@@ -465,7 +464,7 @@
           file: file, line: line
         )
       }
-      var expectedState = self.toLocalState(self.snapshotState)
+      var expectedState = self.toLocalState(self.state)
       do {
         try self.expectedStateShouldChange(
           expected: &expectedState,
@@ -482,7 +481,7 @@
         file: file,
         line: line
       )
-      snapshotState = state
+      self.state = state
       if "\(self.file)" == "\(file)" {
         self.line = line
       }