Skip to content

Commit

Permalink
Fix read_line docs (#629)
Browse files Browse the repository at this point in the history
The result type is not `crossterm::Result` (anymore),
but `std::io::Result`
  • Loading branch information
Hofer-Julian authored Sep 1, 2023
1 parent 31257a4 commit 409b517
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions src/engine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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()?;

Expand Down

0 comments on commit 409b517

Please sign in to comment.