Confusing use of `notify` about mini-redis

[Darksonn]

We had contemplated receiver but thought for new users, coming from other languages, it might be mistaken as an instance (or some such concept) of Receiver, while from (weak/flawed) memory it is a Future.

No, it isn't a Future. It is an instance of the type tokio::sync::broadcast::Receiver.

---

As for the word "monitor", I find that word very unnatural here. If we are to rephrase the sentence, I would prefer this:

/// Shutdown signals are received using a `broadcast::Receiver`.

[Darksonn]

Changing it to listen or receiver sounds reasonable to me. I do not think that collect and gather would be good names.

[bbros-dev]

Thanks for the feedback. We had contemplated receiver but thought for new users, coming from other languages, it might be mistaken as an instance (or some such concept) of Receiver, while from (weak/flawed) memory it is a Future.

We're still working through this example so will likely wait a while before making an PR - to ensure we haven't misunderstood.

For future reference, we also thought this line (signalling is a synonym for sending):

/// Shutdown is signalled using a `broadcast::Receiver`.

might be better phrased:

/// Shutdown signals are monitored via a `broadcast::Receiver`.

Which of course suggests that monitor is a better replacement term for notify?

[bbros-dev]

receiver it is then.