nushell/reedline
1
1
Fork 0
mirror of https://github.com/nushell/reedline.git synced 2024-09-11 15:55:50 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix read_line docs (#629)

Browse Source 
The result type is not `crossterm::Result` (anymore),
but `std::io::Result`
This commit is contained in:
Hofer-Julian 2023-09-01 22:31:19 +02:00 committed by GitHub
parent 31257a4c54
commit 409b51784f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/engine.rs
View File

@ -593,9 +593,8 @@ impl Reedline {
/// Wait for input and provide the user with a specified [`Prompt`].
///
/// Returns a [`crossterm::Result`] in which the `Err` type is [`crossterm::ErrorKind`]
/// to distinguish I/O errors and the `Ok` variant wraps a [`Signal`] which
/// handles user inputs.
/// Returns a [`std::io::Result`] in which the `Err` type is [`std::io::Result`]
/// and the `Ok` variant wraps a [`Signal`] which handles user inputs.
pub fn read_line(&mut self, prompt: &dyn Prompt) -> Result<Signal> {
terminal::enable_raw_mode()?;