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

Rename StateObject:get() to better fit its new behaviour #159

Closed
dphfox opened this issue May 8, 2022 · 1 comment
Closed

Rename StateObject:get() to better fit its new behaviour #159

dphfox opened this issue May 8, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@dphfox
Copy link
Owner

dphfox commented May 8, 2022

If we're going ahead with #111, then we'll be changing the behaviour of :get() here to explicitly only return a value, without adding any dependencies whatsoever. However, this might not necessarily be how someone would expect the API to work; it's possible someone might think that :get() still adds dependencies as it once did, or still have leftover code in some corner of their codebase which wasn't updated correctly.

With this in mind, it might be a good idea to choose a new name for the method (preferably one less overloaded with interpretations) to reflect the fact that it no longer does the same thing, and is much more passive in nature. I like the sound of :peek() (as in, to 'peek at' the value without invoking any dependency-adding code) but other suggestions would be welcome here too.

@dphfox
Copy link
Owner Author

dphfox commented Aug 30, 2022

Closing in favour of #168

@dphfox dphfox closed this as completed Aug 30, 2022
@dphfox dphfox added status: rejected and removed not ready - evaluating Currently gauging feedback labels Aug 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant