Skip to content

Commit

Permalink
docs: Fix wrong link in docs of Poller::wait()
Browse files Browse the repository at this point in the history
Once upon a time, this got a Vec as an argument, but that was replaced
with the Events struct. Thus, this should link to Events and not Vec.

Signed-off-by: Uli Schlachter <psychon@znc.in>
  • Loading branch information
psychon authored Oct 20, 2023
1 parent 37a1d4e commit 0575cbd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -609,8 +609,8 @@ impl Poller {

/// Waits for at least one I/O event and returns the number of new events.
///
/// New events will be appended to `events`. If necessary, make sure to clear the [`Vec`]
/// before calling [`wait()`][`Poller::wait()`]!
/// New events will be appended to `events`. If necessary, make sure to clear the
/// [`Events`][Events::clear()] before calling [`wait()`][`Poller::wait()`]!
///
/// This method will return with no new events if a notification is delivered by the
/// [`notify()`] method, or the timeout is reached. Sometimes it may even return with no events
Expand Down

0 comments on commit 0575cbd

Please sign in to comment.