diff --git a/src/bot.jl b/src/bot.jl index a1b870bd3..b89dec1fc 100644 --- a/src/bot.jl +++ b/src/bot.jl @@ -1,18 +1,18 @@ export precompileActivator, precompileDeactivator, precompilePather, @snoopiBot, @snoopiBenchBot, BotConfig -UStrings = Union{AbstractString,Regex,AbstractChar} +const UStrings = Union{AbstractString,Regex,AbstractChar} ################################################################ """ BotConfig -Config object that holds the options and configuration for the snoopCompile bot. This object is fed to the `@snoopiBot`. +Config object that holds the options and configuration for the SnoopCompile bot. This object is fed to the `@snoopiBot`. # Arguments: -- packageName::String -- subst::Vector{Pair{UStrings, UStrings}} : to replace a packages precompile setences with another's package like ["ImageTest" => "Images"] -- blacklist::Vector{UStrings} : to remove some precompile sentences +- `packageName::String` +- `subst::Vector{Pair{UStrings, UStrings}}` : to replace a packages precompile setences with another's package like `["ImageTest" => "Images"]` +- `blacklist::Vector{UStrings}` : to remove some precompile sentences -UStrings == Union{AbstractString,Regex,AbstractChar} # every string like type that replace() has a method for. +`const UStrings == Union{AbstractString,Regex,AbstractChar}` # every string like type that `replace()` has a method for. """ struct BotConfig packageName::String