refactor(RCON): add description for RegisterCommand methods

fix #91
VeniceUnleashed · Dec 16, 2021 · bf6888a · bf6888a
1 parent 4b456df
commit bf6888a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/content/vext/ref/server/library/rcon.md b/content/vext/ref/server/library/rcon.md
@@ -62,7 +62,7 @@ title: RCON
 | ---- | ---- | ----------- |
 | **command** | string |  |
 | **flags** | [RemoteCommandFlag](/vext/ref/shared/type/remotecommandflag) |  |
-| **callback** | callable |  |
+| **callback** | callable | A callback in the form `function(command: string, args: string{}, loggedIn: bool): string{}`. |
 
 #### Returns
 
@@ -80,8 +80,8 @@ title: RCON
 | ---- | ---- | ----------- |
 | **command** | string |  |
 | **flags** | [RemoteCommandFlag](/vext/ref/shared/type/remotecommandflag) |  |
-| **context** | any |  |
-| **callback** | callable |  |
+| **context** | any | A context value to pass to the callback. |
+| **callback** | callable | A callback in the form `function(context: any, command: string, args: string{}, loggedIn: bool): string{}`. |
 
 #### Returns
 

diff --git a/types/server/library/RCON.yaml b/types/server/library/RCON.yaml
@@ -30,6 +30,7 @@ methods:
         type: RemoteCommandFlag
       callback:
         type: callable
+        description: "A callback in the form `function(command: string, args: string{}, loggedIn: bool): string{}`."
     returns:
       type: int
   -
@@ -41,8 +42,10 @@ methods:
         type: RemoteCommandFlag
       context:
         type: any
+        description: A context value to pass to the callback.
       callback:
         type: callable
+        description: "A callback in the form `function(context: any, command: string, args: string{}, loggedIn: bool): string{}`."
     returns:
       type: int
   -