Skip to content

DocC organization #2118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 18, 2023
Merged

DocC organization #2118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a73e97
DocC organization
stephencelis May 18, 2023
9ea7e8d
wip
stephencelis May 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion Sources/ComposableArchitecture/Documentation.docc/ComposableArchitecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ day-to-day when building applications, such as:

### Testing

- <doc:Testing>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We link to this in the same section under the "Essentials", so this felt a little redundant...

- ``TestStore``

## See Also
Expand Down
4 changes: 4 additions & 0 deletions ...eArchitecture/Documentation.docc/Extensions/Deprecations/ReducerDeprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ instead.
- ``AnyReducer``
- ``Reducer``
- ``DebugEnvironment``

### Reducer modifiers

- ``ReducerProtocol/debug()``
1 change: 1 addition & 0 deletions ...bleArchitecture/Documentation.docc/Extensions/Deprecations/StoreDeprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Avoid using deprecated APIs in your app. Select a method to see the replacement
### Creating a store

- ``Store/init(initialState:reducer:environment:)``
- ``Store/init(initialState:reducer:prepareDependencies:)``

### Scoping stores

Expand Down
4 changes: 4 additions & 0 deletions ...rchitecture/Documentation.docc/Extensions/Deprecations/TestStoreDeprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ Avoid using deprecated APIs in your app. Select a method to see the replacement

### Creating a test store

- ``TestStore/init(initialState:reducer:prepareDependencies:file:line:)-55zkv``
- ``TestStore/init(initialState:reducer:observe:prepareDependencies:file:line:)``
- ``TestStore/init(initialState:reducer:observe:send:prepareDependencies:file:line:)``
- ``TestStore/init(initialState:reducer:environment:file:line:)``
- ``TestStore/init(initialState:reducer:withDependencies:file:line:)-1l3ek``
- ``TestStore/init(initialState:reducer:prepareDependencies:file:line:)-72tkt``

### Configuring a test store
Expand Down
5 changes: 5 additions & 0 deletions ...rchitecture/Documentation.docc/Extensions/Deprecations/ViewStoreDeprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Avoid using deprecated APIs in your app. Select a method to see the replacement

- ``ViewStore/suspend(while:)``

### Supporting types

- ``ViewStore/State-swift.typealias``
- ``ViewStore/Action``

### SwiftUI integration

- ``ViewStore/subscript(dynamicMember:)-3q4xh``
Expand Down
1 change: 1 addition & 0 deletions Sources/ComposableArchitecture/Documentation.docc/Extensions/ReducerProtocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
- ``dependency(_:_:)``
- ``transformDependency(_:transform:)``
- ``signpost(_:log:)``
- ``_printChanges(_:)``

### Supporting types

Expand Down
2 changes: 1 addition & 1 deletion Sources/ComposableArchitecture/Documentation.docc/Extensions/Store.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Creating a store

- ``init(initialState:reducer:prepareDependencies:)``
- ``init(initialState:reducer:withDependencies:)``
- ``StoreOf``

### Scoping stores
Expand Down
6 changes: 3 additions & 3 deletions Sources/ComposableArchitecture/Documentation.docc/Extensions/TestStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

### Creating a test store

- ``init(initialState:reducer:prepareDependencies:file:line:)-55zkv``
- ``init(initialState:reducer:observe:prepareDependencies:file:line:)``
- ``init(initialState:reducer:observe:send:prepareDependencies:file:line:)``
- ``init(initialState:reducer:withDependencies:file:line:)-6s32h``
- ``init(initialState:reducer:observe:withDependencies:file:line:)``
- ``init(initialState:reducer:observe:send:withDependencies:file:line:)``

### Configuring a test store

Expand Down
3 changes: 3 additions & 0 deletions Sources/ComposableArchitecture/Documentation.docc/Extensions/ViewStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

### Creating a view store

- ``init(_:observe:send:removeDuplicates:)``
- ``init(_:observe:removeDuplicates:)``
- ``init(_:observe:send:)``
- ``init(_:observe:)``
- ``init(_:)-4il0f``
- ``ViewStoreOf``
Expand All @@ -25,6 +27,7 @@

- ``send(_:animation:)``
- ``send(_:animation:while:)``
- ``send(_:transaction:)``
- <doc:Bindings>
- ``objectWillChange-5oies``

Expand Down
5 changes: 5 additions & 0 deletions Sources/ComposableArchitecture/Internal/Deprecations.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,11 @@ extension TestStore {
line: line
)
}

@available(iOS, deprecated: 9999, message: "Pass a closure as the reducer.")
@available(macOS, deprecated: 9999, message: "Pass a closure as the reducer.")
@available(tvOS, deprecated: 9999, message: "Pass a closure as the reducer.")
@available(watchOS, deprecated: 9999, message: "Pass a closure as the reducer.")
public convenience init<R: ReducerProtocol>(
initialState: @autoclosure () -> State,
reducer: R,
Expand Down