diff --git a/src/Ellie.Marmalade/Canary.cs b/src/Ellie.Marmalade/Canary.cs index 19f1d47..64a9c4c 100644 --- a/src/Ellie.Marmalade/Canary.cs +++ b/src/Ellie.Marmalade/Canary.cs @@ -4,14 +4,14 @@ namespace Ellie.Canary; /// /// The base class which will be loaded as a module into EllieBot -/// Any user-defined snek has to inherit from this class. -/// Sneks get instantiated ONLY ONCE during the loading, -/// and any snek commands will be executed on the same instance. +/// Any user-defined canary has to inherit from this class. +/// Canaries get instantiated ONLY ONCE during the loading, +/// and any canary commands will be executed on the same instance. /// -public abstract class Snek : IAsyncDisposable +public abstract class Canary : IAsyncDisposable { /// - /// Name of the snek. Defaults to the lowercase class name + /// Name of the canary. Defaults to the lowercase class name /// public virtual string Name => GetType().Name.ToLowerInvariant(); @@ -25,14 +25,14 @@ public abstract class Snek : IAsyncDisposable => string.Empty; /// - /// Executed once this snek has been instantiated and before any command is executed. + /// Executed once this canary has been instantiated and before any command is executed. /// /// A representing completion public virtual ValueTask InitializeAsync() => default; /// - /// Override to cleanup any resources or references which might hold this snek in memory + /// Override to cleanup any resources or references which might hold this canary in memory /// /// public virtual ValueTask DisposeAsync() @@ -83,8 +83,8 @@ public abstract class Snek : IAsyncDisposable /// /// This method is called after the command was found but not executed, /// and can be used to prevent the command's execution. - /// The command information doesn't have to be from this snek as this method - /// will be called when *any* command from any module or snek was found. + /// The command information doesn't have to be from this canary as this method + /// will be called when *any* command from any module or canary was found. /// You can choose to prevent the execution of the command by returning "true" value. /// Execution order: /// @@ -95,7 +95,7 @@ public abstract class Snek : IAsyncDisposable /// /// /// Command context - /// Name of the snek or module from which the command originates + /// Name of the canary or module from which the command originates /// Name of the command which is about to be executed /// A representing whether the execution should be blocked public virtual ValueTask ExecPreCommandAsync(