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

Document observe_value better #741

Open
DominicOram opened this issue Jan 21, 2025 · 0 comments
Open

Document observe_value better #741

DominicOram opened this issue Jan 21, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@DominicOram
Copy link
Contributor

When working with observe_value it's not always obvious on the edge cases of it e.g.:

  • Do I get a value immediately on calling observe_value?
  • When do I get a new value? Do I get one if the there's a callback but the value remains the same?

I think the answers to this are both yes but we should make sure and document it in the docstring

Acceptance Criteria

  • The docstring of observe_value answers the above questions
@coretl coretl self-assigned this Jan 21, 2025
@coretl coretl added the documentation Improvements or additions to documentation label Jan 21, 2025
@coretl coretl added this to the 1.0 milestone Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants