From b13e2f94733afccfe02275fca263bde1dc532d2f Mon Sep 17 00:00:00 2001 From: Valentin271 <36198422+Valentin271@users.noreply.github.com> Date: Mon, 2 Sep 2024 00:30:13 +0200 Subject: [PATCH] docs(backend): added link to stdio FAQ (#1349) --- src/backend/crossterm.rs | 5 +++++ src/backend/termion.rs | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/src/backend/crossterm.rs b/src/backend/crossterm.rs index f5076c5c..d374441e 100644 --- a/src/backend/crossterm.rs +++ b/src/backend/crossterm.rs @@ -93,6 +93,11 @@ where { /// Creates a new `CrosstermBackend` with the given writer. /// + /// Most applications will use either [`stdout`](std::io::stdout) or + /// [`stderr`](std::io::stderr) as writer. See the [FAQ] to determine which one to use. + /// + /// [FAQ]: https://ratatui.rs/faq/#should-i-use-stdout-or-stderr + /// /// # Example /// /// ```rust,no_run diff --git a/src/backend/termion.rs b/src/backend/termion.rs index bfa804b5..bd7577e6 100644 --- a/src/backend/termion.rs +++ b/src/backend/termion.rs @@ -76,6 +76,11 @@ where { /// Creates a new Termion backend with the given writer. /// + /// Most applications will use either [`stdout`](std::io::stdout) or + /// [`stderr`](std::io::stderr) as writer. See the [FAQ] to determine which one to use. + /// + /// [FAQ]: https://ratatui.rs/faq/#should-i-use-stdout-or-stderr + /// /// # Example /// /// ```rust,no_run