From d912d96f00eb593e01218cd03bd2c1cb069a6d83 Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Mon, 19 Jul 2021 09:08:55 +0530
Subject: [PATCH] More docs cleanups

---
 docs/integrations.rst          |  8 ++++++--
 docs/kittens/broadcast.rst     |  4 +++-
 docs/kittens/clipboard.rst     |  4 +++-
 docs/layouts.rst               |  3 ---
 docs/marks.rst                 | 11 +++++------
 kittens/query_terminal/main.py |  7 ++++---
 6 files changed, 21 insertions(+), 16 deletions(-)

diff --git a/docs/integrations.rst b/docs/integrations.rst
index e82a7e80a..c220c3d8e 100644
--- a/docs/integrations.rst
+++ b/docs/integrations.rst
@@ -65,7 +65,9 @@ System and data visualisation tools
 
 `gnuplot <http://www.gnuplot.info/>`_
     a graphing and data visualization tool that can be made to display its
-    output in kitty with the following bash snippet::
+    output in kitty with the following bash snippet:
+
+    .. code-block:: sh
 
         function iplot {
             cat <<EOF | gnuplot
@@ -79,7 +81,9 @@ System and data visualisation tools
             EOF
         }
 
-   Add this to bashrc and then to plot a function, simply do::
+    Add this to bashrc and then to plot a function, simply do:
+
+    .. code-block:: sh
 
         iplot 'sin(x*3)*exp(x*.2)'
 
diff --git a/docs/kittens/broadcast.rst b/docs/kittens/broadcast.rst
index 2b8d08453..56c68ad1e 100644
--- a/docs/kittens/broadcast.rst
+++ b/docs/kittens/broadcast.rst
@@ -1,6 +1,8 @@
-broadcast - type text in all kitty windows
+broadcast
 ==================================================
 
+*Type text in all kitty windows simultaneously*
+
 The ``broadcast`` kitten can be used to type text simultaneously in
 all kitty windows (or a subset as desired).
 
diff --git a/docs/kittens/clipboard.rst b/docs/kittens/clipboard.rst
index b0b819716..9f5bae0de 100644
--- a/docs/kittens/clipboard.rst
+++ b/docs/kittens/clipboard.rst
@@ -1,6 +1,8 @@
-clipboard - copy/paste to the system clipboard
+clipboard
 ==================================================
 
+*Copy/paste to the system clipboard from shell scripts*
+
 .. highlight:: sh
 
 
diff --git a/docs/layouts.rst b/docs/layouts.rst
index dcd165d8b..17d2d0901 100644
--- a/docs/layouts.rst
+++ b/docs/layouts.rst
@@ -27,9 +27,6 @@ you can switch layouts using :sc:`next_layout`. To control which layouts
 are available use :opt:`enabled_layouts`, the first listed layout becomes
 the default. Individual layouts and how to use them are described below.
 
-.. contents::
-   :local:
-
 
 The Stack Layout
 ------------------
diff --git a/docs/marks.rst b/docs/marks.rst
index 4c699ce64..1904be160 100644
--- a/docs/marks.rst
+++ b/docs/marks.rst
@@ -89,12 +89,11 @@ The syntax of the :code:`toggle_marker` command is::
 
 Here :code:`marker-type` is one of:
 
-    * :code:`text` - simple substring matching
-    * :code:`itext` - case-insensitive substring matching
-    * :code:`regex` - A python regular expression
-    * :code:`iregex` - A case-insensitive python regular expression
-    * :code:`function` - An arbitrary function defined in a python file, see
-      :ref:`marker_funcs`.
+* :code:`text` - simple substring matching
+* :code:`itext` - case-insensitive substring matching
+* :code:`regex` - A python regular expression
+* :code:`iregex` - A case-insensitive python regular expression
+* :code:`function` - An arbitrary function defined in a python file, see :ref:`marker_funcs`.
 
 .. _marker_funcs:
 
diff --git a/kittens/query_terminal/main.py b/kittens/query_terminal/main.py
index d1af60756..2343ef324 100644
--- a/kittens/query_terminal/main.py
+++ b/kittens/query_terminal/main.py
@@ -209,11 +209,12 @@ def options_spec() -> str:
 careful not to perform any I/O on the terminal device
 until the kitten exits.
 
-Available queries are::
+Available queries are:
 
 {}
-'''.format('  ' + '\n  '.join(
-    f'{name}: {c.help_text}' for name, c in all_queries.items()))
+
+'''.format('\n'.join(
+    f'``{name}``\n  {c.help_text}\n' for name, c in all_queries.items()))
 usage = '[query1 query2 ...]'