search

hannobraun / inotify-rs

Idiomatic inotify wrapper for the Rust programming language
ISC License
254 stars 65 forks source link

Improve documentation of `Inotify::event_stream` #132

Open hannobraun opened 5 years ago

hannobraun commented 5 years ago

The documentation for Inotify::event_stream is out of date.

  1. It talks about using an internal buffer, but it no longer does.
  2. It could use examples showing the various usage scenarios.

The examples should document what kinds of values can be passes as a buffer. See this comment in #124 and this comment in #125 for more information.