clean up

Author: mbrandonw

Sources/ComposableArchitecture/Documentation.docc/Extensions/ViewStore.md

@@ -4,14 +4,15 @@
 
 ### Creating a View Store
 
-- ``init(_:removeDuplicates:)``
+- ``init(_:observe:removeDuplicates:)``
+- ``init(_:observe:)``
 - ``init(_:)-4il0f``
 <!--NB: DocC fails to resolve the following topic-->
 <!--- ``init(_:)-1pfeq`-->
 
 ### Accessing State
 
-- ``state``
+- ``state-swift.property``
 - ``subscript(dynamicMember:)-kwxk``
 
 ### Sending Actions

Sources/ComposableArchitecture/Documentation.docc/Extensions/ViewStoreDeprecations.md

@@ -8,6 +8,11 @@ Avoid using deprecated APIs in your app. Select a method to see the replacement
 
 ## Topics
 
+### Creating a view store
+
+- ``ViewStore/init(_:removeDuplicates:)``
+- ``ViewStore/init(_:)-1pfeq``
+
 ### Interacting with Concurrency
 
 - ``ViewStore/suspend(while:)``

Sources/ComposableArchitecture/ViewStore.swift

@@ -137,29 +137,60 @@ public final class ViewStore<ViewState, ViewAction>: ObservableObject {
 
   /// Initializes a view store from a store.
   ///
+  /// > Warning: This initializer is deprecated. Use
+  /// ``ViewStore/init(_:observe:removeDuplicates:)`` to make state observation explicit.
+  /// >
+  /// > When using ``ViewStore`` you should take care to observe only the pieces of state that
+  /// your view needs to do its job, especially towards the root of the application. See
+  /// <doc:Performance> for more details.
+  ///
   /// - Parameters:
   ///   - store: A store.
   ///   - isDuplicate: A function to determine when two `State` values are equal. When values are
   ///     equal, repeat view computations are removed.
   @available(
     iOS,
     deprecated: 9999.0,
-    message: "Use 'init(_:observe:removeDuplicates:)' to make state observation explicit."
+    message: """
+      Use 'init(_:observe:removeDuplicates:)' to make state observation explicit.
+
+      When using ViewStore you should take care to observe only the pieces of state that your view needs to do its job, especially towards the root of the application. See the performance article for more details:
+
+      https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/performance#View-stores
+      """
   )
   @available(
     macOS,
     deprecated: 9999.0,
-    message: "Use 'init(_:observe:removeDuplicates:)' to make state observation explicit."
+    message: """
+      Use 'init(_:observe:removeDuplicates:)' to make state observation explicit.
+
+      When using ViewStore you should take care to observe only the pieces of state that your view needs to do its job, especially towards the root of the application. See the performance article for more details:
+
+      https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/performance#View-stores
+      """
   )
   @available(
     tvOS,
     deprecated: 9999.0,
-    message: "Use 'init(_:observe:removeDuplicates:)' to make state observation explicit."
+    message: """
+      Use 'init(_:observe:removeDuplicates:)' to make state observation explicit.
+
+      When using ViewStore you should take care to observe only the pieces of state that your view needs to do its job, especially towards the root of the application. See the performance article for more details:
+
+      https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/performance#View-stores
+      """
   )
   @available(
     watchOS,
     deprecated: 9999.0,
-    message: "Use 'init(_:observe:removeDuplicates:)' to make state observation explicit."
+    message: """
+      Use 'init(_:observe:removeDuplicates:)' to make state observation explicit.
+
+      When using ViewStore you should take care to observe only the pieces of state that your view needs to do its job, especially towards the root of the application. See the performance article for more details:
+
+      https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/performance#View-stores
+      """
   )
   public init(
     _ store: Store<ViewState, ViewAction>,
@@ -552,25 +583,60 @@ extension ViewStore where ViewState: Equatable {
     self.init(store, observe: toViewState, send: fromViewAction, removeDuplicates: ==)
   }
 
+  /// Initializes a view store from a store.
+  ///
+  /// > Warning: This initializer is deprecated. Use
+  /// ``ViewStore/init(_:observe:)`` to make state observation explicit.
+  /// >
+  /// > When using ``ViewStore`` you should take care to observe only the pieces of state that
+  /// your view needs to do its job, especially towards the root of the application. See
+  /// <doc:Performance> for more details.
+  ///
+  /// - Parameters:
+  ///   - store: A store.
   @available(
     iOS,
     deprecated: 9999.0,
-    message: "Use 'init(_:observe:)' to make state observation explicit."
+    message: """
+      Use 'init(_:observe:)' to make state observation explicit.
+
+      When using ViewStore you should take care to observe only the pieces of state that your view needs to do its job, especially towards the root of the application. See the performance article for more details:
+
+      https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/performance#View-stores
+      """
   )
   @available(
     macOS,
     deprecated: 9999.0,
-    message: "Use 'init(_:observe:)' to make state observation explicit."
+    message: """
+      Use 'init(_:observe:)' to make state observation explicit.
+
+      When using ViewStore you should take care to observe only the pieces of state that your view needs to do its job, especially towards the root of the application. See the performance article for more details:
+
+      https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/performance#View-stores
+      """
   )
   @available(
     tvOS,
     deprecated: 9999.0,
-    message: "Use 'init(_:observe:)' to make state observation explicit."
+    message: """
+      Use 'init(_:observe:)' to make state observation explicit.
+
+      When using ViewStore you should take care to observe only the pieces of state that your view needs to do its job, especially towards the root of the application. See the performance article for more details:
+
+      https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/performance#View-stores
+      """
   )
   @available(
     watchOS,
     deprecated: 9999.0,
-    message: "Use 'init(_:observe:)' to make state observation explicit."
+    message: """
+      Use 'init(_:observe:)' to make state observation explicit.
+
+      When using ViewStore you should take care to observe only the pieces of state that your view needs to do its job, especially towards the root of the application. See the performance article for more details:
+
+      https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/performance#View-stores
+      """
   )
   public convenience init(_ store: Store<ViewState, ViewAction>) {
     self.init(store, removeDuplicates: ==)