Add AtomDerivedScope and deprecate AtomScope(inheriting:content:) #175
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces the new AtomDerivedScope view to replace the deprecated observe/override functionality from AtomScope. The changes update the documentation with new usage examples and API listings to clarify how to explicitly derive the atom store from a parent view context.
- Added AtomDerivedScope documentation and example usage in README.md.
- Updated the API list in the Atoms documentation.
- Modified workaround instructions to reference AtomDerivedScope instead of AtomScope.
Reviewed Changes
Copilot reviewed 2 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Added a dedicated section for AtomDerivedScope and replaced legacy AtomScope usage examples. |
| Sources/Atoms/Atoms.docc/Atoms.md | Updated the API reference list to include AtomDerivedScope. |
Files not reviewed (3)
- Sources/Atoms/AtomDerivedScope.swift: Language not supported
- Sources/Atoms/AtomScope.swift: Language not supported
- Sources/Atoms/PropertyWrapper/ViewContext.swift: Language not supported
Comments suppressed due to low confidence (1)
README.md:1809
- [nitpick] The documentation references AtomViewContext while the examples use a context provided by @ViewContext. Consider aligning the terminology for clarity.
As a workaround, you can use `AtomDerivedScope` to explicitly inherit the atom store through `AtomViewContext` from the parent view.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Type
Description
AtomScope's APIs for adding observers/overrides while inheriting parent contexts have been deprecated and now it asserts internally.
So this PR aims to add a new view without observe/override functionality so that the interface doesn't confuse users, and the original
AtomScope.init(inheriting:content:)has now been deprecated.