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.

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

Documentation of Inotify::into_event_stream is misleading #132

Open
hannobraun opened this issue Jun 23, 2019 · 1 comment
Open

Documentation of Inotify::into_event_stream is misleading #132

hannobraun opened this issue Jun 23, 2019 · 1 comment

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.

@hannobraun hannobraun changed the title Improve documentation of Inotify::event_stream Documentation of Inotify::into_event_stream is misleading Jan 14, 2025
@hannobraun
Copy link
Owner Author

hannobraun commented Jan 14, 2025

event_stream is deprecated now, but the documentation of its successor, into_event_stream, still talks about the same internal buffer that doesn't exist.

@hannobraun hannobraun added the bug label Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant