Skip to content

Shared state composable ViewStore example#13

Merged
Pearapps merged 81 commits intomainfrom
kpa/testing-composibility-shared-state-and-viewstore
May 17, 2023
Merged

Shared state composable ViewStore example#13
Pearapps merged 81 commits intomainfrom
kpa/testing-composibility-shared-state-and-viewstore

Conversation

@Pearapps
Copy link
Contributor

@Pearapps Pearapps commented Apr 5, 2023

Provides a simple demonstration of the ability to compose Stores.

@Pearapps Pearapps requested review from Cordavi, Twigz and mliberatore May 9, 2023 17:05
@Pearapps
Copy link
Contributor Author

Pearapps commented May 9, 2023

Updated a bunch of stuff here.... I think we should be better now

Copy link
Contributor

@mliberatore mliberatore left a comment

Choose a reason for hiding this comment

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

Code looks great. Most of these comments are tiny suggestions or simple docs-related stuff. One general piece of feedback I have is about the contents of the docs similar to the following:

/// State of the banner data store
let bannerState: BannerDataStore.State

/// Determines if the update view should be shown
let showUpdateView: Bool

These docs mostly reword the property name without additional context added. I know in some cases, there really isn’t much that could be added to further explain what a symbol’s name already self-documents (like Banner’s title at the top of the diff), and that makes the task of adding documentation to adhere to guidelines pretty tedious. But in some cases, particularly like showUpdateView, I think we could be more specific, answering questions like "what is an update view"? For example: Determines whether to show a view that allows the user to enter new text for the banner.

Pearapps and others added 8 commits May 10, 2023 10:58
…teController.swift

Co-authored-by: Michael Liberatore <mi@chael.co>
…ateViewStore.swift

Co-authored-by: Michael Liberatore <mi@chael.co>
Co-authored-by: Michael Liberatore <mi@chael.co>
@Pearapps
Copy link
Contributor Author

Did another pass on this, this morning!

@Pearapps
Copy link
Contributor Author

Code looks great. Most of these comments are tiny suggestions or simple docs-related stuff. One general piece of feedback I have is about the contents of the docs similar to the following:

/// State of the banner data store
let bannerState: BannerDataStore.State

/// Determines if the update view should be shown
let showUpdateView: Bool

These docs mostly reword the property name without additional context added. I know in some cases, there really isn’t much that could be added to further explain what a symbol’s name already self-documents (like Banner’s title at the top of the diff), and that makes the task of adding documentation to adhere to guidelines pretty tedious. But in some cases, particularly like showUpdateView, I think we could be more specific, answering questions like "what is an update view"? For example: Determines whether to show a view that allows the user to enter new text for the banner.

I went through and tried to beef up some of the docs, even if only a little. I am struggling with some of them to add additional context

@Pearapps Pearapps requested a review from mliberatore May 16, 2023 15:55
Copy link
Contributor

@mliberatore mliberatore left a comment

Choose a reason for hiding this comment

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

Looks great 🙌. One tiny grammar correction, then feel free to merge it with no further review.

…teController.swift

Co-authored-by: Michael Liberatore <mi@chael.co>
@Pearapps
Copy link
Contributor Author

Thank you @mliberatore ! Appreciate your reviews and patience with this!

@Pearapps Pearapps merged commit 37fb876 into main May 17, 2023
@mliberatore
Copy link
Contributor

🎉

@Pearapps Pearapps deleted the kpa/testing-composibility-shared-state-and-viewstore branch May 17, 2023 16:09
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.

4 participants