Skip to content

Commit d7b64af

Browse files
committed
clarify gui/launcher docs, code comments
1 parent 38a490f commit d7b64af

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

docs/gui/launcher.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,28 +38,30 @@ the dialog immediately so you can get back to the game, use
3838
:kbd:`Shift`:kbd:`Enter` or hold down the :kbd:`Shift` key and click on the
3939
``run`` button instead. The dialog also closes automatically if you run a
4040
command that brings up a new GUI screen. In any case, the command output will
41-
also be written to the DFHack terminal console.
41+
also be written to the DFHack terminal console if you need to find it later.
4242

4343
Autocomplete
4444
------------
4545

4646
As you type, autocomplete options for DFHack commands appear in the right
4747
column. If the first word of what you've typed matches a valid command, then the
4848
autocomplete options will also include commands that have similar functionality
49-
to the one that you've named. Click on an autocomplete option to select it or
50-
cycle through them with :kbd:`Tab` or :kbd:`Shift`:kbd:`Tab`.
49+
to the one that you've named. Click on an autocomplete list option to select it
50+
or cycle through them with :kbd:`Tab` and :kbd:`Shift`:kbd:`Tab`.
5151

5252
Context-sensitive help
5353
----------------------
5454

5555
When you start ``gui/launcher`` without parameters, it shows some useful
56-
information in the help area about how to get started.
56+
information in the help area about how to get started with browsing DFHack tools
57+
by their category `tags`.
5758

5859
Once you have typed (or autocompleted) a word that matches a valid command, the
5960
help area shows the help for that command, including usage instructions and
60-
examples. You can scroll the help text by clicking on the scrollbar or with
61-
:kbd:`PgUp` and :kbd:`PgDn`. You can also scroll line by line with
62-
:kbd:`Ctrl`:kbd:`Up` and :kbd:`Ctrl`:kbd:`Down`.
61+
examples. You can scroll the help text by half-pages by clicking on the
62+
scrollbar or with :kbd:`PgUp` and :kbd:`PgDn`. You can also scroll line by line
63+
with :kbd:`Ctrl`:kbd:`Up` and :kbd:`Ctrl`:kbd:`Down`, or by clicking on the
64+
scrollbar arrows.
6365

6466
Command history
6567
---------------

gui/launcher.lua

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,7 @@ end
307307
--
308308
HelpPanel = defclass(HelpPanel, widgets.Panel)
309309

310+
-- this text is intentionally unwrapped so the in-UI wrapping can do the job
310311
local DEFAULT_HELP_TEXT = [[Welcome to DFHack!
311312
312313
Type a command to see its help text here. Hit ENTER to run the command, or Shift-ENTER to run the command and close this dialog. The dialog also closes automatically if you run a command that shows a new GUI screen.

0 commit comments

Comments
 (0)