reference: use simple present rather than imperative

Also remove some superfluous documentation of obvious arguments.

Signed-off-by: Luca Zeuch <[email protected]>

Author: l-zeuch

content/docs/reference/templates/functions.md

@@ -24,21 +24,18 @@ Unless specified otherwise, these functions accept an ID, name, or `nil` for the
 {{ addThreadMember <thread> <member> }}
 ```
 
-Add a member to an existing thread. Does nothing if either argument is invalid.
-
-- `thread`: the thread to add the member to.
-- `member`: the member's ID.
+Adds a member to an existing thread. Does nothing if either argument is invalid.
 
 ### createForumPost
 
 ```yag
 {{ $post := createForumPost <channel> <name> <content> [values] }}
 ```
 
-Create a new forum post. Returns a channel object on success.
+Creates a new forum post. Returns a channel object on success.
 
 - `channel`: the forum channel to post to.
-- `name`: The post title. May not be empty.
+- `name`: The post title. May not be empty. Must be a string.
 - `content`: the initial message's content; may be a string, an embed, or a complex message. May not be empty.
 - `values` (optional): Additional options for the post. May include:
   - `"slowmode"`: The thread's slowmode in seconds.
@@ -51,7 +48,7 @@ Create a new forum post. Returns a channel object on success.
 {{ $thread := createThread <channel> <messageID> <name> [private] [auto_archive_duration] [invitable] }}
 ```
 
-Create a new thread in the specified channel. Returns a channel object on success.
+Creates a new thread in the specified channel. Returns a channel object on success.
 
 - `channel`: the parent channel to create the thread in.
 - `message`: either `nil` to create a channel thread, or a message ID to create a message thread.
@@ -76,9 +73,7 @@ is archived after an hour and allows non-moderators to add others:
 {{ deleteForumPost <post> }}
 ```
 
-Delete the given forum post.
-
-- `post`: The post to delete.
+Deletes the given forum post.
 
 This function is functionally the same to [deleteThread](#deletethread).
 Use whichever function is semantically more meaningful in the context of your custom command.
@@ -89,9 +84,7 @@ Use whichever function is semantically more meaningful in the context of your cu
 {{ deleteThread <thread> }}
 ```
 
-Delete the given thread.
-
-- `thread`: the thread to delete.
+Deletes the given thread.
 
 This function is functionally the same to [deleteForumPost](#deleteforumpost).
 Use whichever function is semantically more meaningful in the context of your custom command.
@@ -102,9 +95,8 @@ Use whichever function is semantically more meaningful in the context of your cu
 {{ editChannelName <channel> <newName> }}
 ```
 
-Edit the name of the given channel.
+Edits the name of the given channel.
 
-- `channel`: the channel to edit.
 - `newName`: the new name for the channel. Must be a string.
 
 This function is, together with [editChannelTopic](#editchanneltopic), limited to 10 calls per custom command execution.
@@ -116,9 +108,8 @@ In addition to this, Discord limits the number of channel modifications to 2 per
 {{ editChannelTopic <channel> <newTopic> }}
 ```
 
-Edit the topic of the given channel.
+Edits the topic of the given channel.
 
-- `channel`: the channel to modify.
 - `newTopic`: the channel's new topic. Must be a string. Discord markdown is supported.
 
 This function is, together with [editChannelName](#editchannelname), limited to 10 calls per custom command execution.
@@ -130,19 +121,15 @@ In addition to this, Discord limits the number of channel modifications to 2 per
 {{ $channel := getChannelOrThread <channel> }}
 ```
 
-Return the full channel or thread object for the given channel.
-
-- `channel`: the channel or thread to get.
+Returns the full channel or thread object for the given channel.
 
 ### getChannelPins
 
 ```yag
 {{ $pins := getChannelPins <channel> }}
 ```
 
-Return a slice of message objects pinned to the channel or thread.
-
-- `channel`: the channel or thread to get pinned messages from.
+Returns a slice of message objects pinned to the given channel or thread.
 
 Rate-limited to 2 (premium: 4) calls per custom command execution.
 
@@ -152,29 +139,23 @@ Rate-limited to 2 (premium: 4) calls per custom command execution.
 {{ $channel := getChannel <channel> }}
 ```
 
-Return the full channel object for the given channel. Will not work for threads.
-
-- `channel`: the channel to get.
+Returns the full channel object for the given channel. Will not work for threads.
 
 ### getPinCount
 
 ```yag
 {{ $numPins := getPinCount <channel> }}
 ```
 
-Return the number of pinned messages in given channel.
-
-- `channel`: the channel to count pinned messages in.
+Returns the number of pinned messages in given channel.
 
 ### getThread
 
 ```yag
 {{ $thread := getThread <thread> }}
 ```
 
-Return the full thread object for the given thread. Will not work for channels.
-
-- `thread`: the thread to get.
+Returns the full thread object for the given thread. Will not work for channels.
 
 ### removeThreadMember
 
@@ -184,9 +165,6 @@ Return the full thread object for the given thread. Will not work for channels.
 
 Removes the given member from the given thread.
 
-- `thread`: the thread to remove the member from.
-- `member`: the member's ID to remove.
-
 ## Database
 
 | **Function**                                      | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |