From 8fe9a1d54e69579f44cf83bdfd195e4640b83302 Mon Sep 17 00:00:00 2001
From: Alexandre Bury <alexandre.bury@gmail.com>
Date: Fri, 22 Feb 2019 15:30:22 -0800
Subject: [PATCH] Better documentation for Cursive

---
 examples/dialog.rs |  2 +-
 src/cursive.rs     | 29 ++++++++++++++++++++++++++++-
 src/logger.rs      |  2 +-
 3 files changed, 30 insertions(+), 3 deletions(-)

diff --git a/examples/dialog.rs b/examples/dialog.rs
index 630d4c6..f09386e 100644
--- a/examples/dialog.rs
+++ b/examples/dialog.rs
@@ -13,7 +13,7 @@ fn main() {
         CircularFocus::wrap_tab(
             Dialog::around(TextView::new("Hello Dialog!"))
                 .title("Cursive")
-                .button("Foo", |s| ())
+                .button("Foo", |_s| ())
                 .button("Quit", |s| s.quit()),
         ),
     );
diff --git a/src/cursive.rs b/src/cursive.rs
index 974c3f7..1dcc86c 100644
--- a/src/cursive.rs
+++ b/src/cursive.rs
@@ -121,6 +121,25 @@ impl Default for Cursive {
 
 impl Cursive {
     /// Creates a new Cursive root, and initialize the back-end.
+    ///
+    /// * If you just want a cursive instance, use `Cursive::default()`.
+    /// * If you want a specific backend, then:
+    ///   * `Cursive::ncurses()` if the `ncurses-backend` feature is enabled (it is by default).
+    ///   * `Cursive::pancurses()` if the `pancurses-backend` feature is enabled.
+    ///   * `Cursive::termion()` if the `termion-backend` feature is enabled.
+    ///   * `Cursive::blt()` if the `blt-backend` feature is enabled.
+    ///   * `Cursive::dummy()` for a dummy backend, mostly useful for tests.
+    /// * If you want to use a third-party backend, then `Cursive::new` is indeed the way to go:
+    ///   * `Cursive::new(bring::your::own::Backend::new)`
+    ///
+    /// Examples:
+    ///
+    /// ```rust
+    /// # use cursive::{Cursive, backend};
+    /// let siv = Cursive::new(backend::curses::n::Backend::init);
+    /// let siv = Cursive::ncurses(); // equivalent to the line above.
+    /// let siv = Cursive::default(); // with the default features, equivalent to the line above
+    /// ```
     pub fn new<F>(backend_init: F) -> Self
     where
         F: FnOnce() -> Box<backend::Backend>,
@@ -186,7 +205,7 @@ impl Cursive {
 
     /// Show the debug console.
     ///
-    /// Currently, this will show logs if [`logger::init()`] was called.
+    /// Currently, this will show logs if [`::logger::init()`] was called.
     pub fn show_debug_console(&mut self) {
         self.add_layer(
             views::Dialog::around(views::ScrollView::new(views::IdView::new(
@@ -198,6 +217,14 @@ impl Cursive {
     }
 
     /// Show the debug console, or hide it if it's already visible.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # use cursive::Cursive;
+    /// # let mut siv = Cursive::dummy();
+    /// siv.add_global_callback('~', Cursive::toggle_debug_console);
+    /// ```
     pub fn toggle_debug_console(&mut self) {
         if let Some(pos) = self.screen_mut().find_layer_from_id(DEBUG_VIEW_ID)
         {
diff --git a/src/logger.rs b/src/logger.rs
index 63347f2..fa46167 100644
--- a/src/logger.rs
+++ b/src/logger.rs
@@ -51,7 +51,7 @@ impl log::Log for CursiveLogger {
 ///
 /// Make sure this is the only logger your are using.
 ///
-/// Use a `DebugView` to see the logs.
+/// Use a [`::views::DebugView`] to see the logs, or use [`::Cursive::toggle_debug_console()`].
 pub fn init() {
     // TODO: Configure the deque size?
     LOGS.lock().unwrap().reserve(1_000);