GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-22 11:59:43 +01:00
Code Issues Projects Releases Wiki Activity

doc/QuoteGrabs.md: minor improvements

Browse Source
This commit is contained in:
Pragmatic Software 2020-01-09 22:16:22 -08:00
parent 9e99c2a58d
commit 706512f0be
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/QuoteGrabs.md
View File

@ -4,7 +4,6 @@ Quotegrabs
PBot can grab user messages and store/recall them for posterity.
<!-- md-toc-begin -->
* [Quotegrabs](#quotegrabs)
* [grab](#grab)
* [getq](#getq)
* [rq](#rq)
@ -14,21 +13,21 @@ PBot can grab user messages and store/recall them for posterity.
### grab
Grabs a message someone says, and adds it to the quotegrabs database. You may grab multiple nicks/messages in one quotegrab by separating the arguments with a plus sign (the nicks need not be different -- you can grab multiple messages by the same nick by specifying a different history for each grab).
You can use the [recall](#recall) command to test the arguments before grabbing (please use a private message).
You can use the `recall` command to test the arguments before grabbing (please use a private message).
Usage: `grab <nick> [history [channel]] [+ ...]`
where [history] is an optional argument regular expression used to search message contents;
e.g., to grab a message containing the text "pizza", use: grab nick pizza
<bob> Clowns are scary.
<pragma-> grab bob clowns
<pragma-> !grab bob clowns
<PBot> Quote grabbed: 1: <bob> Clowns are scary.
<!-- -->
<alice> Please put that in the right place.
<bob> That's what she said!
<pragma-> grab alice place + bob said
<pragma-> !grab alice place + bob said
<PBot> Quote grabbed 2: <alice> Please put that in the right place. <bob> That's what she said!
<!-- -->
@ -37,7 +36,7 @@ Usage: `grab <nick> [history [channel]] [+ ...]`
<charlie> Knock knock!
<charlie> Race condition.
<charlie> Who's there?
<pragma-> grab charlie knock + charlie race + charlie there
<pragma-> !grab charlie knock + charlie race + charlie there
<PBot> Quote grabbed 3: <charlie> Knock knock! <charlie> Race condition. <charlie> Who's there?
### getq
@ -45,6 +44,9 @@ Retrieves and displays a specific grabbed quote from the quotegrabs database.
Usage: `getq <quote-id>`
<pragma-> !getq 1
<PBot> grabbed by pragma- in #channel on Wed Dec 31 16:00:00 1969 [50 years and 21 days ago]
### rq
Retrieves and displays a random grabbed quote from the quotegrabs database. You may filter by nick, channel and/or quote text.