Skip to content
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.

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

[FIX] Fixed API description to use the recent name: EffectTask -> Effect #2389

Merged
merged 1 commit into from
Aug 21, 2023
Merged

[FIX] Fixed API description to use the recent name: EffectTask -> Effect #2389

merged 1 commit into from
Aug 21, 2023

Conversation

x-0o0
Copy link
Contributor

@x-0o0 x-0o0 commented Aug 21, 2023

There's a very minor modification on API description of EffectOf.

The description uses EffectTask in the code snippet, but it should be Effect.

I also searched for EffectTask, but there are no more results of its usage.

Copy link
Member

@mbrandonw mbrandonw left a comment

Choose a reason for hiding this comment

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

Good find, thank you!

@x-0o0 x-0o0 changed the title [FIX] Fixed API description to use recent name: EffectTask -> Effect [FIX] Fixed API description to use the recent name: EffectTask -> Effect Aug 21, 2023
@mbrandonw mbrandonw merged commit c8c7817 into pointfreeco:main Aug 21, 2023
@x-0o0 x-0o0 deleted the fix/jaesung/effect/update-api-docs branch August 21, 2023 17:30
cgrindel-self-hosted-renovate bot referenced this pull request in cgrindel/rules_swift_package_manager Aug 24, 2023
…ure to v1 (#530)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
|
[pointfreeco/swift-composable-architecture](https://togithub.com/pointfreeco/swift-composable-architecture)
| major | `from: "0.58.2"` -> `from: "1.2.0"` |

---

### Release Notes

<details>
<summary>pointfreeco/swift-composable-architecture
(pointfreeco/swift-composable-architecture)</summary>

###
[`v1.2.0`](https://togithub.com/pointfreeco/swift-composable-architecture/releases/tag/1.2.0)

[Compare
Source](https://togithub.com/pointfreeco/swift-composable-architecture/compare/1.1.0...1.2.0)

#### What's Changed

- Added: Legacy alert and action sheet presentation APIs for iOS 13
support
([https://github.com/pointfreeco/swift-composable-architecture/pull/2379](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2379)).
The `alert(store:)` and `confirmationDialog(store:)` view modifiers are
iOS 15+, but we now have `legacyAlert(store:)` and `actionSheet(store:)`
for iOS 13+.
- Added: `TestStore.bindings` for testing bindable view state
([https://github.com/pointfreeco/swift-composable-architecture/pull/2394](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2394)).
- Fixed: Addressed a potential threading issue in `Store.send`
([https://github.com/pointfreeco/swift-composable-architecture/pull/2382](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2382)).
- Fixed: Worked around a Catalina runtime crash due to unavailable macOS
symbols (thanks [@&#8203;jaredh159](https://togithub.com/jaredh159),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2385](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2385)).
- Infrastructure: Docs fixes (thanks
[@&#8203;nickkohrn](https://togithub.com/nickkohrn),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2383](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2383);
[@&#8203;jaesung-0o0](https://togithub.com/jaesung-0o0),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2389](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2389)).
- Infrastructure: Added README section for companion libraries
([https://github.com/pointfreeco/swift-composable-architecture/pull/2395](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2395)).
- Infrastructure: Fixed stack case study
([https://github.com/pointfreeco/swift-composable-architecture/pull/2397](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2397))

#### New Contributors

- [@&#8203;jaredh159](https://togithub.com/jaredh159) made their first
contribution in
[https://github.com/pointfreeco/swift-composable-architecture/pull/2385](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2385)

**Full Changelog**:
pointfreeco/swift-composable-architecture@1.1.0...1.2.0

###
[`v1.1.0`](https://togithub.com/pointfreeco/swift-composable-architecture/releases/tag/1.1.0)

[Compare
Source](https://togithub.com/pointfreeco/swift-composable-architecture/compare/1.0.0...1.1.0)

#### What's Changed

- Added: An overload of `Reducer.onChange(of:)` that takes a
configurable `removeDuplicates` closure for the equality check (thanks
[@&#8203;ohitsdaniel](https://togithub.com/ohitsdaniel),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2338](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2338)).
- Added: `Effect.debounce` and `Effect.throttle`, for debouncing and
throttling effects on a scheduler
([https://github.com/pointfreeco/swift-composable-architecture/pull/2372](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2372),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2368](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2368)).
This functionality existed in past releases but was removed from 1.0
alongside other deprecated Combine code. Because there is no modern
replacement for `Effect.throttle` we have brought this functionality
back to 1.1.
- Fixed: XCTest failures emitted when test stores initialize state
(*e.g.* if `Reducer.State.init` accesses a dependency that hasn't been
overridden) are now shown in the test that creates the store rather than
hidden in application code
([https://github.com/pointfreeco/swift-composable-architecture/pull/2352](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2352)).
- Fixed: Suppressed a warning that previously emitted when instantiating
a test store state with `.init()` instead of `Feature.State()`
([https://github.com/pointfreeco/swift-composable-architecture/pull/2347](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2347)).
- Fixed: Child features presented by *grandparent* features are now
properly dismissed when the child calls `@Dependency(\.dismiss)`
([https://github.com/pointfreeco/swift-composable-architecture/pull/2373](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2373)).
- Infrastructure: Documentation updates and fixes
([https://github.com/pointfreeco/swift-composable-architecture/pull/2336](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2336);
thanks [@&#8203;jayrhynas](https://togithub.com/jayrhynas),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2342](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2342);
thanks [@&#8203;Atimca](https://togithub.com/Atimca),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2350](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2350);
[https://github.com/pointfreeco/swift-composable-architecture/pull/2353](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2353);
thanks [@&#8203;hmhv](https://togithub.com/hmhv),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2355](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2355);
thanks [@&#8203;Ryu0118](https://togithub.com/Ryu0118),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2358](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2358),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2367](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2367);
thanks [@&#8203;yimajo](https://togithub.com/yimajo),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2357](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2357);
thanks [@&#8203;ValseLee](https://togithub.com/ValseLee),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2369](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2369),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2370](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2370)).

#### New Contributors

- [@&#8203;jayrhynas](https://togithub.com/jayrhynas) made their first
contribution in
[https://github.com/pointfreeco/swift-composable-architecture/pull/2342](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2342)
- [@&#8203;Atimca](https://togithub.com/Atimca) made their first
contribution in
[https://github.com/pointfreeco/swift-composable-architecture/pull/2350](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2350)
- [@&#8203;ValseLee](https://togithub.com/ValseLee) made their first
contribution in
[https://github.com/pointfreeco/swift-composable-architecture/pull/2369](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2369)

**Full Changelog**:
pointfreeco/swift-composable-architecture@1.0.0...1.1.0

###
[`v1.0.0`](https://togithub.com/pointfreeco/swift-composable-architecture/releases/tag/1.0.0)

[Compare
Source](https://togithub.com/pointfreeco/swift-composable-architecture/compare/0.59.0...1.0.0)

#### What's Changed

- The Composable Architecture 1.0
([https://github.com/pointfreeco/swift-composable-architecture/pull/2318](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2318)).
Fully removes all deprecated APIs from the 0.x series.

**Full Changelog**:
pointfreeco/swift-composable-architecture@0.58.0...1.0.0

###
[`v0.59.0`](https://togithub.com/pointfreeco/swift-composable-architecture/releases/tag/0.59.0)

[Compare
Source](https://togithub.com/pointfreeco/swift-composable-architecture/compare/0.58.2...0.59.0)

#### What's Changed

- Added: back-ported legacy alert and action sheet APIs for those using
iOS 13 alerts and action sheets in their apps
([https://github.com/pointfreeco/swift-composable-architecture/pull/2379](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2379)).
- Fixed: Addressed a potential threading issue in `Store.send`
([https://github.com/pointfreeco/swift-composable-architecture/pull/2382](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2382)).
- Fixed: Un-deprecated `debounce` and `throttle` overloads restored in
1.1.0 (thanks [@&#8203;pyrtsa](https://togithub.com/pyrtsa),
[https://github.com/pointfreeco/swift-composable-architecture/pull/2392](https://togithub.com/pointfreeco/swift-composable-architecture/pull/2392)).

**Full Changelog**:
pointfreeco/swift-composable-architecture@0.58.2...0.59.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi41Mi4xIiwidXBkYXRlZEluVmVyIjoiMzYuNTIuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: Self-hosted Renovate Bot <361546+cgrindel-self-hosted-renovate[bot]@users.noreply.github.enterprise.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants