Skip to content

Commit

Permalink
Fix: docs typo
Browse files Browse the repository at this point in the history
  • Loading branch information
andretcarpizo committed Dec 22, 2023
1 parent 4ae0ebc commit 88fedcb
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 30 deletions.
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,25 +106,24 @@ use murmur::Whisper;
use std::io::{Error, ErrorKind};

fn main() -> Result<(), Error> {
Whisper::new()
.message("1 message")
.message("2 message")
.message("3 message")
.whisper()
.map_err(|err| Error::new(ErrorKind::Other, err))?;
Ok(())
Whisper::new()
.message("1 message")
.message("2 message")
.message("3 message")
.whisper()
.map_err(|err| Error::new(ErrorKind::Other, err))?;
Ok(())
}
```
Output:

output:

``` text
```
1 message without icon
2 message without icon indents by 2 spaces all messages after the first
3 message
```rust
2 message without icon indents by 2 spaces all messages after the first
3 message
```

### messages
#### messages

```rust
use murmur::Whisper;
Expand All @@ -138,9 +137,7 @@ Whisper::new()
.messages(vec!["1 message without icon", "2 message", "3 message"])
.whisper()
.ok();
```

### Handling Errors with Default Methods

The `whisper` method returns `-> Result<(), WhisperError>`
Expand Down
25 changes: 11 additions & 14 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -104,22 +104,21 @@
//! use std::io::{Error, ErrorKind};
//!
//! fn main() -> Result<(), Error> {
//! Whisper::new()
//! .message("1 message")
//! .message("2 message")
//! .message("3 message")
//! .whisper()
//! .map_err(|err| Error::new(ErrorKind::Other, err))?;
//! Ok(())
//! Whisper::new()
//! .message("1 message")
//! .message("2 message")
//! .message("3 message")
//! .whisper()
//! .map_err(|err| Error::new(ErrorKind::Other, err))?;
//! Ok(())
//! }
//! ```
//! Output:
//!
//! output:
//!
//! ``` text
//! ```text
//! 1 message without icon
//! 2 message without icon indents by 2 spaces all messages after the first
//! 3 message
//! 2 message without icon indents by 2 spaces all messages after the first
//! 3 message
//! ```
//!
//! ### messages
Expand All @@ -136,9 +135,7 @@
//! .messages(vec!["1 message without icon", "2 message", "3 message"])
//! .whisper()
//! .ok();
//!
//! ```
//!
//! ## Handling Errors with Default Methods
//!
//! The `whisper` method returns `-> Result<(), WhisperError>`
Expand Down

0 comments on commit 88fedcb

Please sign in to comment.