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.

Sign up for GitHub

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

Jump to bottom

sync: improve docs for watch channels #5954

Merged
merged 6 commits into from Aug 28, 2023
Merged

sync: improve docs for watch channels #5954

merged 6 commits into from Aug 28, 2023

Commits on Aug 27, 2023

  1. sync: improve docs for watch channels 

    I found the watch docs as written to be somewhat confusing.

* It wasn't clear to me whether values are marked seen or not at
  creation/subscribe time.
* The example also confused me a bit, suggesting a while loop when a
  do-while loop is generally more correct.
* I noticed a potential race with `borrow` that is no longer an issue
  with `borrow_and_update`.

Update the documentation to try and make it clearer.
    @sunshowers
    sunshowers committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    68923a7 View commit details
    Browse the repository at this point in the history

  2. address review comment

    @sunshowers
    sunshowers committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    6d7ec40 View commit details
    Browse the repository at this point in the history

  3. also make it clearer that borrow doesn't change its state

    @sunshowers
    sunshowers committed Aug 27, 2023
    Configuration menu
    Copy the full SHA
    0b7f413 View commit details
    Browse the repository at this point in the history

Commits on Aug 28, 2023

  1. address review comment

    @sunshowers
    sunshowers committed Aug 28, 2023
    Configuration menu
    Copy the full SHA
    7091060 View commit details
    Browse the repository at this point in the history

  2. more review comments

    @sunshowers
    sunshowers committed Aug 28, 2023
    Configuration menu
    Copy the full SHA
    cc0433d View commit details
    Browse the repository at this point in the history

  3. add links to borrow_and_update-versus-borrow

    @sunshowers
    sunshowers committed Aug 28, 2023
    Configuration menu
    Copy the full SHA
    4caf956 View commit details
    Browse the repository at this point in the history