Skip to content

Commit 2c87cf8

Browse files
authored
doc clarifications
1 parent 3093a3f commit 2c87cf8

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/plugins/spectate.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,10 @@ Examples
6363
Show informative tooltips that follow each unit on the map. Note that this
6464
can be enabled independently of `spectate` itself.
6565

66-
``spectate set tooltip-follow-job-shortenings "Store item in stockpile" "Store item"``
67-
Set a (see ``tooltip-follow-job-shortenings`` for details).
66+
``spectate set tooltip-follow-job-shortenings "Store item in stockpile" "Store"``
67+
Abbreviate the names of "Store item in stockpile" jobs to just "Store" when the
68+
job is displayed in the `spectate` tooltips. See the
69+
``tooltip-follow-job-shortenings`` setting below for details.
6870

6971
Settings
7072
--------
@@ -118,10 +120,11 @@ Settings
118120
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
119121
job of the dwarf in the tooltip.
120122

121-
``tooltip-follow-job-shortenings``
123+
``tooltip-follow-job-shortenings`` (default: "Store item in stockpile" -> "Store item")
122124
If the ``spectate.tooltip`` overlay is enabled, this dictionary is used to
123125
shorten some job names, f.e. "Store item in stockpile" becomes "Store item".
124-
See examples for an example.
126+
You can pass two parameters to ``spectate set tooltip-follow-job-shortenings`` to
127+
add or change elements in the dictionary. See the Examples section for an example.
125128

126129
``tooltip-follow-name`` (default: enabled)
127130
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
@@ -135,7 +138,7 @@ Settings
135138
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
136139
specific happiness level (stress) of the dwarf in the tooltip. F.e.
137140
``tooltip-follow-stress-levels 2 true`` would show the Displeased emoticon.
138-
See ``tooltip-stress-levels`` for details.
141+
See ``tooltip-stress-levels`` below for details.
139142

140143
``tooltip-hover`` (default: enabled)
141144
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
@@ -157,7 +160,7 @@ Settings
157160
If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
158161
specific happiness level (stress) of the dwarf in the hover panel. F.e.
159162
``tooltip-hover-stress-levels 2 true`` would show the Displeased emoticon.
160-
See ``tooltip-stress-levels`` for details.
163+
See ``tooltip-stress-levels`` below for details.
161164

162165
``tooltip-stress-levels``
163166
Controls how happiness levels (stress) are displayed (emoticon and color).
@@ -202,7 +205,7 @@ Settings
202205
- =D
203206
- COLOR_LIGHTCYAN
204207

205-
Keep in mind that the text will look different with the game's font.
208+
Keep in mind that the text may look different when rendered in the game's font.
206209

207210
Overlays
208211
--------

0 commit comments

Comments
 (0)