GitHub
/
pbot
mirror of https://github.com/pragma-/pbot.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: improve Functions documentation

This commit is contained in:
Pragmatic Software 2020-02-13 18:25:33 -08:00
parent 69fc64e1d7
commit 0b900144d5
2 changed files with 56 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -268,7 +268,33 @@ Module | Description
For more information, see the [Modules documentation](doc/Modules.md).
### Functions
Functions are "commands" that accept input, manipulates it and then outputs the result.
Functions are commands that accept input, manipulate it and then output the result. They are extremely
useful with [piping](#piping) or [command substituting](#substitution).
For example, the `uri_escape` function demonstrated in the [Substitutions](#substitutions) section earlier
makes text safe for use in a URL. We also saw the `sed` and `uc` functions demonstrated in [Piping](#piping).
<pragma-> uri_escape thing's & words
<PBot> thing%27s%20%26%20words
As demonstrated previously, the `sed` function replaces text using a substitution regex. The `uc` function
uppercases the text.
<pragma-> echo Hello world! | {sed s/world/universe/} | {uc}
<PBot> HELLO UNIVERSE!
Here's a short list of the Functions that come with PBot.
Name | Description
--- | ---
`uri_escape` | Percent-encodes unsafe URI characters.
`sed` | Performs sed-like regex substitution.
`pluralize` | Intelligently makes a word or phrase plural.
`unquote` | Removes surrounding quotation marks.
`title` | Title-cases text. That is, lowercases the text then uppercases the first letter of each word.
`ucfirst` | Uppercases the first character of the text.
`uc` | Uppercases all characters.
`lc` | Lowercases all characters.
For more information, see the [Functions documentation](doc/Functions.md).

31
doc/Functions.md
View File

@ -1,5 +1,32 @@
# Functions
Coming soon.
This is a place-holder from the main [README](../README.md#functions) until I have time to flesh this out more.
If you've already read that section, there is nothing new here.
Last edit: Feb 14, 2020
Functions are commands that accept input, manipulate it and then output the result. They are extremely
useful with [piping](../README.md#piping) or [command substituting](../README.md#substitution).
For example, the `uri_escape` function demonstrated in the [Substitutions](../README.md#substitutions) section earlier
makes text safe for use in a URL. We also saw the `sed` and `uc` functions demonstrated in [Piping](../README.md#piping).
<pragma-> uri_escape thing's & words
<PBot> thing%27s%20%26%20words
As demonstrated previously, the `sed` function replaces text using a substitution regex. The `uc` function
uppercases the text.
<pragma-> echo Hello world! | {sed s/world/universe/} | {uc}
<PBot> HELLO UNIVERSE!
Here's a short list of the Functions that come with PBot.
Name | Description
--- | ---
`uri_escape` | Percent-encodes unsafe URI characters.
`sed` | Performs sed-like regex substitution.
`pluralize` | Intelligently makes a word or phrase plural.
`unquote` | Removes surrounding quotation marks.
`title` | Title-cases text. That is, lowercases the text then uppercases the first letter of each word.
`ucfirst` | Uppercases the first character of the text.
`uc` | Uppercases all characters.
`lc` | Lowercases all characters.