Merge pull request #243 from seam345/develop

remove reference to for_each_incoming
This commit is contained in:
Aaron Weiss 2022-08-15 13:09:32 -07:00 committed by GitHub
commit 78216d601c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -984,8 +984,7 @@ impl Client {
/// Gets a stream of incoming messages from the `Client`'s connection. This is only necessary /// Gets a stream of incoming messages from the `Client`'s connection. This is only necessary
/// when trying to set up more complex clients, and requires use of the `futures` crate. Most /// when trying to set up more complex clients, and requires use of the `futures` crate. Most
/// IRC bots should be able to get by using only `for_each_incoming` to handle received /// You can find some examples of setups using `stream` in the
/// messages. You can find some examples of more complex setups using `stream` in the
/// [GitHub repository](https://github.com/aatxe/irc/tree/stable/examples). /// [GitHub repository](https://github.com/aatxe/irc/tree/stable/examples).
/// ///
/// **Note**: The stream can only be returned once. Subsequent attempts will cause a panic. /// **Note**: The stream can only be returned once. Subsequent attempts will cause a panic.