Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-06 15:29:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

getting_started: fix typos / reword introduction in help syntax section

Browse Source
This commit is contained in:
James Lu
2025-02-04 18:17:17 -08:00
parent 2af19fa8fe
commit 43be77fe2c
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
use/getting_started.rst
View File

@ -220,8 +220,8 @@ or the Plugins list on `limnoria.net <https://limnoria.net/plugins.xhtml>`_.
Understanding the help syntax Understanding the help syntax
============================= =============================
The syntax of a command describes how to run a command. This section further explains the help syntax given by the ``help`` command.
The syntax is given by the help command.
Some examples: Some examples:
help [<plugin>] [<command>] help [<plugin>] [<command>]
@ -230,9 +230,9 @@ help [<plugin>] [<command>]
The chevrons mean you have to replace <plugin> and <command> by a plugin The chevrons mean you have to replace <plugin> and <command> by a plugin
name and a command name. name and a command name.
The brackets mean the argument they wrap is **optional**. The square brackets mean the arguments they wrap are **optional**.
So, the fellowing commands are correct:: So, the following commands are correct::
<user> help <user> help
<user> help PluginName <user> help PluginName
@ -249,7 +249,7 @@ join <channel> [<key>]
It requires a channel name, and the channel key is optional. It requires a channel name, and the channel key is optional.
This two commands are ok:: These two commands are ok::
<user> join #limnoria <user> join #limnoria
<user> join #limnoria MySecretKey <user> join #limnoria MySecretKey