From 191b74df6fa44c96dbf283b84859147249814b47 Mon Sep 17 00:00:00 2001
From: Fabian Homborg <FHomborg@gmail.com>
Date: Fri, 29 Mar 2019 20:55:28 +0100
Subject: [PATCH] docs: Fix some sphinx errors

See #5696.

[ci skip]
---
 sphinx_doc_src/cmds/bind.rst                  |  2 +-
 sphinx_doc_src/cmds/complete.rst              | 30 ++++++++++---------
 sphinx_doc_src/cmds/disown.rst                |  4 +--
 .../cmds/fish_breakpoint_prompt.rst           |  2 ++
 sphinx_doc_src/cmds/fish_git_prompt.rst       |  4 +--
 sphinx_doc_src/cmds/fish_opt.rst              |  7 +++--
 sphinx_doc_src/cmds/fish_prompt.rst           |  8 +++--
 sphinx_doc_src/cmds/fish_right_prompt.rst     |  8 +++--
 sphinx_doc_src/cmds/fish_svn_prompt.rst       |  1 -
 sphinx_doc_src/cmds/umask.rst                 |  2 +-
 sphinx_doc_src/index.rst                      |  3 +-
 11 files changed, 39 insertions(+), 32 deletions(-)

diff --git a/sphinx_doc_src/cmds/bind.rst b/sphinx_doc_src/cmds/bind.rst
index a7b028800..5fb4d38b1 100644
--- a/sphinx_doc_src/cmds/bind.rst
+++ b/sphinx_doc_src/cmds/bind.rst
@@ -26,7 +26,7 @@ SEQUENCE is the character sequence to bind to. These should be written as <a hre
 
 The default key binding can be set by specifying a ``SEQUENCE`` of the empty string (that is, ``''`` ). It will be used whenever no other binding matches. For most key bindings, it makes sense to use the ``self-insert`` function (i.e. ``````bind '' self-insert``````) as the default keybinding. This will insert any keystrokes not specifically bound to into the editor. Non- printable characters are ignored by the editor, so this will not result in control sequences being printable.
 
-If the ``-k`` switch is used, the name of the key (such as 'down', 'up' or 'backspace') is used instead of a sequence. The names used are the same as the corresponding curses variables, but without the 'key_' prefix. (See ``terminfo(5)`` for more information, or use ``bind --key-names`` for a list of all available named keys.) If used in conjunction with the ``-s`` switch, ``bind`` will silently ignore bindings to named keys that are not found in termcap for the current ``$TERMINAL``, otherwise a warning is emitted.
+If the ``-k`` switch is used, the name of the key (such as 'down', 'up' or 'backspace') is used instead of a sequence. The names used are the same as the corresponding curses variables, but without the 'key\_' prefix. (See ``terminfo(5)`` for more information, or use ``bind --key-names`` for a list of all available named keys.) If used in conjunction with the ``-s`` switch, ``bind`` will silently ignore bindings to named keys that are not found in termcap for the current ``$TERMINAL``, otherwise a warning is emitted.
 
 ``COMMAND`` can be any fish command, but it can also be one of a set of special input functions. These include functions for moving the cursor, operating on the kill-ring, performing tab completion, etc. Use ``bind --function-names`` for a complete list of these input functions.
 
diff --git a/sphinx_doc_src/cmds/complete.rst b/sphinx_doc_src/cmds/complete.rst
index ab3ba1007..d1e3f1cec 100644
--- a/sphinx_doc_src/cmds/complete.rst
+++ b/sphinx_doc_src/cmds/complete.rst
@@ -4,20 +4,22 @@ complete - edit command specific tab-completions
 Synopsis
 --------
 
-complete ( -c | --command | -p | --path ) COMMAND
-        [( -c | --command | -p | --path ) COMMAND]...
-        [( -e | --erase )]
-        [( -s | --short-option ) SHORT_OPTION]...
-        [( -l | --long-option | -o | --old-option ) LONG_OPTION]...
-        [( -a | --arguments ) OPTION_ARGUMENTS]
-        [( -k | --keep-order )]
-        [( -f | --no-files )]
-        [( -r | --require-parameter )]
-        [( -x | --exclusive )]
-        [( -w | --wraps ) WRAPPED_COMMAND]...
-        [( -n | --condition ) CONDITION]
-        [( -d | --description ) DESCRIPTION]
-complete ( -C[STRING] | --do-complete[=STRING] )
+::
+
+  complete ( -c | --command | -p | --path ) COMMAND
+          [( -c | --command | -p | --path ) COMMAND]...
+          [( -e | --erase )]
+          [( -s | --short-option ) SHORT_OPTION]...
+          [( -l | --long-option | -o | --old-option ) LONG_OPTION]...
+          [( -a | --arguments ) OPTION_ARGUMENTS]
+          [( -k | --keep-order )]
+          [( -f | --no-files )]
+          [( -r | --require-parameter )]
+          [( -x | --exclusive )]
+          [( -w | --wraps ) WRAPPED_COMMAND]...
+          [( -n | --condition ) CONDITION]
+          [( -d | --description ) DESCRIPTION]
+  complete ( -C[STRING] | --do-complete[=STRING] )
 
 
 Description
diff --git a/sphinx_doc_src/cmds/disown.rst b/sphinx_doc_src/cmds/disown.rst
index 65732b389..3d726f557 100644
--- a/sphinx_doc_src/cmds/disown.rst
+++ b/sphinx_doc_src/cmds/disown.rst
@@ -4,7 +4,7 @@ disown - remove a process from the list of jobs
 Synopsis
 --------
 
-disown [ PID ... ]
+``disown [ PID ... ]``
 
 
 Description
@@ -14,7 +14,7 @@ Description
 
 Jobs in the list of jobs are sent a hang-up signal when fish terminates, which usually causes the job to terminate; ``disown`` allows these processes to continue regardless.
 
-If no process is specified, the most recently-used job is removed (like ``bg`` and ``fg``).  If one or more ``PID``s are specified, jobs with the specified process IDs are removed from the job list. Invalid jobs are ignored and a warning is printed.
+If no process is specified, the most recently-used job is removed (like ``bg`` and ``fg``).  If one or more PIDs are specified, jobs with the specified process IDs are removed from the job list. Invalid jobs are ignored and a warning is printed.
 
 If a job is stopped, it is sent a signal to continue running, and a warning is printed. It is not possible to use the ``bg`` builtin to continue a job once it has been disowned.
 
diff --git a/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst b/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst
index b60eee2b2..e5c8f4d0f 100644
--- a/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst
+++ b/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst
@@ -4,6 +4,8 @@ fish_breakpoint_prompt - define the prompt when stopped at a breakpoint
 Synopsis
 --------
 
+::
+
     function fish_breakpoint_prompt
         ...
     end
diff --git a/sphinx_doc_src/cmds/fish_git_prompt.rst b/sphinx_doc_src/cmds/fish_git_prompt.rst
index a3aeab276..221feefa8 100644
--- a/sphinx_doc_src/cmds/fish_git_prompt.rst
+++ b/sphinx_doc_src/cmds/fish_git_prompt.rst
@@ -40,7 +40,7 @@ There are numerous configuration options, either as fish variables or git config
 
 A number of variables set characters and color used to indicate things. Many of these have a different default if used with informative status enabled. The normal default is given first, then the informative default if it is different. If no default for the colors is given, they default to ``$__fish_git_prompt_color``.
 
-- ``$__fish_git_prompt_char_stateseparator`` (' ', |)
+- ``$__fish_git_prompt_char_stateseparator`` (' ', `|`)
 - ``$__fish_git_prompt_color`` ('')
 - ``$__fish_git_prompt_color_prefix``
 - ``$__fish_git_prompt_color_suffix``
@@ -54,7 +54,7 @@ Some variables are only used in some modes, like when informative status is enab
 
 Variables used with showdirtystate:
 
-- ``$__fish_git_prompt_char_dirtystate`` (*, ✚)
+- ``$__fish_git_prompt_char_dirtystate`` (`*`, ✚)
 - ``$__fish_git_prompt_char_invalidstate`` (#, ✖)
 - ``$__fish_git_prompt_char_stagedstate`` (+, ●)
 - ``$__fish_git_prompt_color_dirtystate`` (red with showcolorhints, same as color_flags otherwise)
diff --git a/sphinx_doc_src/cmds/fish_opt.rst b/sphinx_doc_src/cmds/fish_opt.rst
index 0d3516500..e0032b58c 100644
--- a/sphinx_doc_src/cmds/fish_opt.rst
+++ b/sphinx_doc_src/cmds/fish_opt.rst
@@ -4,9 +4,10 @@ fish_opt - create an option spec for the argparse command
 Synopsis
 --------
 
-fish_opt [ -h | --help ]
-fish_opt ( -s X | --short=X ) [ -l LONG | --long=LONG ] [ --long-only ] \
-    [ -o | --optional-val ] [ -r | --required-val ] [ --multiple-vals ]
+::
+
+  fish_opt [ -h | --help ]
+  fish_opt ( -s X | --short=X ) [ -l LONG | --long=LONG ] [ --long-only ] [ -o | --optional-val ] [ -r | --required-val ] [ --multiple-vals ]
 
 
 Description
diff --git a/sphinx_doc_src/cmds/fish_prompt.rst b/sphinx_doc_src/cmds/fish_prompt.rst
index 99a047a1c..db302d9e7 100644
--- a/sphinx_doc_src/cmds/fish_prompt.rst
+++ b/sphinx_doc_src/cmds/fish_prompt.rst
@@ -4,9 +4,11 @@ fish_prompt - define the appearance of the command line prompt
 Synopsis
 --------
 
-function fish_prompt
-    ...
-end
+::
+
+  function fish_prompt
+      ...
+  end
 
 
 Description
diff --git a/sphinx_doc_src/cmds/fish_right_prompt.rst b/sphinx_doc_src/cmds/fish_right_prompt.rst
index 01e8cc263..55237d703 100644
--- a/sphinx_doc_src/cmds/fish_right_prompt.rst
+++ b/sphinx_doc_src/cmds/fish_right_prompt.rst
@@ -4,9 +4,11 @@ fish_right_prompt - define the appearance of the right-side command line prompt
 Synopsis
 --------
 
-function fish_right_prompt
-    ...
-end
+::
+
+  function fish_right_prompt
+      ...
+  end
 
 
 Description
diff --git a/sphinx_doc_src/cmds/fish_svn_prompt.rst b/sphinx_doc_src/cmds/fish_svn_prompt.rst
index f467f31e2..5770585f8 100644
--- a/sphinx_doc_src/cmds/fish_svn_prompt.rst
+++ b/sphinx_doc_src/cmds/fish_svn_prompt.rst
@@ -13,7 +13,6 @@ There are numerous configuration options:
 
 
 - $__fish_svn_prompt_color_revision, the colour of the revision number to display in the prompt
-# setting the prompt status separator character
 - $__fish_svn_prompt_char_separator, the separator between status characters
 
 And
diff --git a/sphinx_doc_src/cmds/umask.rst b/sphinx_doc_src/cmds/umask.rst
index 8775c8a5c..ff18bfac2 100644
--- a/sphinx_doc_src/cmds/umask.rst
+++ b/sphinx_doc_src/cmds/umask.rst
@@ -14,7 +14,7 @@ Description
 
 The umask may be expressed either as an octal number, which represents the rights that will be removed by default, or symbolically, which represents the only rights that will be granted by default.
 
-Access rights are explained in the manual page for the ``chmod``(1) program.
+Access rights are explained in the manual page for the ``chmod(1)`` program.
 
 With no parameters, the current file creation mode mask is printed as an octal number.
 
diff --git a/sphinx_doc_src/index.rst b/sphinx_doc_src/index.rst
index 3065d1cd8..d8b060778 100644
--- a/sphinx_doc_src/index.rst
+++ b/sphinx_doc_src/index.rst
@@ -453,8 +453,7 @@ Fish automatically searches through any directories in the array variable ``$fis
 By default, Fish searches the following for functions, using the first available file that it finds:
 - A directory for end-users to keep their own functions, usually ``~/.config/fish/functions`` (controlled by the ``XDG_CONFIG_HOME`` environment variable).
 - A directory for systems administrators to install functions for all users on the system, usually ``/etc/fish/functions`` (really ``$__fish_sysconfdir/functions``).
-- A directory for third-party software vendors to ship their own functions for their software, usually ``/usr/share/fish/vendor_functions.d``.
-  (set at compile time; by default, ``$__fish_data_dir/vendor_functions.d``)
+- A directory for third-party software vendors to ship their own functions for their software, usually ``/usr/share/fish/vendor_functions.d``. (set at compile time; by default, ``$__fish_data_dir/vendor_functions.d``)
 - The functions shipped with fish, usually installed in ``/usr/share/fish/functions`` (really ``$__fish_data_dir/functions``).
 
 These paths are controlled by parameters set at build, install, or run time, and may vary from the defaults listed above.