Add comments to feature flags

This commit is contained in:
Timon 2023-04-08 15:34:23 +02:00
parent b2cbd94853
commit 769b18151c

View File

@ -27,12 +27,12 @@ all-features = true
# #
[features] [features]
default = ["bracketed-paste", "windows", "events"] default = ["bracketed-paste", "windows", "events"]
windows = ["dep:winapi", "dep:crossterm_winapi"] windows = ["dep:winapi", "dep:crossterm_winapi"] # Disables winapi dependencies from being included into the binary (SHOULD NOT be disabled on windows).
bracketed-paste = [] bracketed-paste = [] # Enables triggering a `Event::Paste` when pasting text into the terminal.
event-stream = ["futures-core", "events"] event-stream = ["dep:futures-core", "events"] # Enables async events
use-dev-tty = ["filedescriptor"] use-dev-tty = ["filedescriptor"] # Enables raw file descriptor polling / selecting instead of mio.
events = ["dep:mio", "dep:signal-hook", "dep:signal-hook-mio"] events = ["dep:mio", "dep:signal-hook", "dep:signal-hook-mio"] # Enables reading input/events from the system.
serde = ["dep:serde", "bitflags/serde"] serde = ["dep:serde", "bitflags/serde"] # Enables 'serde' for various types.
# #
# Shared dependencies # Shared dependencies