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

Improve documentation of Inotify::event_stream #132

Open
hannobraun opened this issue Jun 23, 2019 · 0 comments
Open

Improve documentation of Inotify::event_stream #132

hannobraun opened this issue Jun 23, 2019 · 0 comments
Labels
good first issue help wanted

Comments

@hannobraun
Copy link
Owner

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hannobraun