diff --git a/docs/html/search.html b/docs/html/search.html
index 37070f6a..da119ced 100644
--- a/docs/html/search.html
+++ b/docs/html/search.html
@@ -86,6 +86,7 @@
royalnet.database royalnet.network royalnet.utils royalnet.error royalnet.utils
royalnet.error royalnet.utils
-
+Miscellaneous useful functions and classes.
+
royalnet.utils.asyncify( function: Callable , *args , **kwargs )
-
+Convert a function into a coroutine.
+
+
Warning
+
The coroutine cannot be cancelled, and any attempts to do so will result in unexpected outputs.
+
class royalnet.utils.Call( channel, command: Type[royalnet.utils.command.Command], command_args: List[str] = None, **kwargs )
-A command call. Still an abstract class, subbots should create a new call from this.
+A command call. An abstract class, sub-bots should create a new call class from this.
+
+
+__init__( channel, command: Type[royalnet.utils.command.Command], command_args: List[str] = None, **kwargs )
+Create the call.
+
+Parameters
+
+channel – The channel object this call was sent in.
command – The command to be called.
command_args – The arguments to be passed to the command
kwargs – Additional optional keyword arguments that may be passed to the command, possibly specific to the bot.
+
+
+
+
+
+_session_init( )
+If the command requires database access, create a royalnet.database.Alchemy
+
+
alchemy = NotImplemented
@@ -174,8 +204,15 @@
get_author( error_if_none=False )
Try to find the universal identifier of the user that sent the message.
-That probably means, the database row identifying the user.
-Raise a UnregisteredError if error_if_none is set to True and no author is found.
+That probably means, the database row identifying the user.
+
+Parameters
+error_if_none – Raise a royalnet.error.UnregisteredError
+Raises
+royalnet.error.UnregisteredError
+
@@ -195,31 +232,40 @@ Raise a UnregisteredError if error_if_none is set to True and no author is found
-net_request( message: royalnet.network.messages.Message , destination: str )
-Send data to the rest of the Royalnet, and optionally wait for an answer.
-The data must be pickleable.
+net_request( message , destination: str ) → royalnet.network.messages.Reply
+Send data through a royalnet.network.RoyalnetLink royalnet.network.Reply
+
+Parameters
+
+
+
-reply( text: str )
-Send a text message to the channel the call was made.
+reply( text: str ) → None
+Send a text message to the channel where the call was made.
+
+Parameters
+text – The text to be sent, possibly formatted in the weird undescribed markup that I’m using.
+
run( )
-
+Execute the called command, and return the command result.
+
session_end( )
-
-
-
-
-session_init( )
-
+Close the previously created royalnet.database.Alchemy
+
@@ -266,13 +312,25 @@ The data must be pickleable.
-royalnet.utils.safeformat( string: str , ignore_escaping: bool = False , **words ) → str
-
+royalnet.utils.safeformat( string: str , **words ) → str
+str.format()
+
+Parameters
+
+
+Returns
+The formatted string.
+
+
royalnet.utils.cdj( class_ ) → dict
-Return the cleaned class attributes in a dict.
+Return a dict of the class attributes without the __module__ __dict__ __weakref__ __doc__
@@ -291,10 +349,10 @@ The data must be pickleable.
Convert an int
Parameters
-i – the int
+i – the int
Returns
-The resulting str
+The resulting str
@@ -302,21 +360,65 @@ The data must be pickleable.
class royalnet.utils.CommandArgs
-The arguments of a command. Raises InvalidInputError
+The arguments of a command.
+
+
+__getitem__( item )
+Arguments can be accessed with an array notation, such as args[0]
+
+Raises
+InvalidInputError
+
+
+
-joined( * , require_at_least=0 )
-
+joined( * , require_at_least=0 ) → str
+Get the arguments as a space-joined string.
+
+Parameters
+require_at_least – the minimum amount of arguments required, will raise royalnet.error.InvalidInputError
+Raises
+royalnet.error.InvalidInputError
+Returns
+The space-joined string.
+
+
match( pattern: Pattern[AnyStr] ) → Sequence[AnyStr]
-
+Match the royalnet.utils.commandargs.joined()
+
+Parameters
+pattern – The regex pattern to be passed to re.match()
+Returns
+The matched groups, as returned by re.Match.groups()
+
+
-optional( index: int , default=None ) → Optional
-
+optional( index: int , default=None )
+Get the argument at a specific index, but don’t raise an error if nothing is found, instead returning the default
+
+Parameters
+
+
+Returns
+Either the argument or the default None
+
+
-royalnet.utils.safefilename( string: str )
+royalnet.utils.safefilename( string: str ) → str
Ensure a string can be used as a filename by replacing all non-word characters with underscores.
@@ -347,6 +449,8 @@ The data must be pickleable.