search

crossterm-rs / crossterm

Cross platform terminal library rust
MIT License
3.28k stars 281 forks source link

Document the feature `use-dev-tty` on `crossterm::event::{poll, read}` #849

Closed sigoden closed 11 months ago

sigoden commented 11 months ago

Is your feature request related to a problem? Please describe.

If you use crossterm::event::poll/crossterm::event::read, and if your CLI supports reading from stdin, then an error will occur on macOS.

sigoden/aichat#257 helix-editor/helix#5468.

This is a trap.

Describe the solution you'd like

Add a document on crossterm::event::poll/crossterm::event::read to warn developers about the problem and the solution.

texastoland commented 8 months ago

Your issue helped me fix a bug! But I checked the commit history and couldn't find where it's documented?