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

nonsensical wording in docs for watch #238

Open
Luna5829 opened this issue Jul 22, 2023 · 1 comment
Open

nonsensical wording in docs for watch #238

Luna5829 opened this issue Jul 22, 2023 · 1 comment

Comments

@Luna5829
Copy link

Luna5829 commented Jul 22, 2023

in the docs for the watch function, specifically under the definition for "step",
it says "time to wait for new changes in milliseconds, if no changes are detected in this time, and at least one change has been detected, the changes are yielded."
I am specifically talking about the "if no changes are detected in this time, and at least one change has been detected" part,
it makes no sense, it's basically saying, "if no changes have been made, and a change has been made"which makes 0 sense.
I'm assuming you wrote those docs but if you didn't idk lol
It'd make more sense for it to just simply say "if at least one change has been detected"
making it be "time to wait for new changes in milliseconds, if at least one change has been detected, the changes are yielded."
which is a lot clearer and actually makes sense
it's possible I'm just misunderstanding what it's suppose to say but idk

@samuelcolvin
Copy link
Owner

PR welcome to improve the docs.

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

No branches or pull requests

2 participants