Rename log_args to log

Author: omus

src/Sinks/formatlogger.jl

@@ -9,17 +9,17 @@ end
     FormatLogger(formatter, io::IO=stderr; always_flush=true)
 
 Logger sink that formats the message and finally writes to `io`.
-The formatting function should be of the form `formatter(io::IOContext, log_args::NamedTuple)`
-where `log_args` has the following fields:
+The formatting function should be of the form `formatter(io::IOContext, log::NamedTuple)`
+where `log` has the following fields:
 `(level, message, _module, group, id, file, line, kwargs)`.
 See [`LoggingExtras.handle_message_args`](@ref) for more information on what field is.
 
 # Examples
 ```julia-repl
 julia> using Logging, LoggingExtras
 
-julia> logger = FormatLogger() do io, args
-           println(io, args._module, " | ", "[", args.level, "] ", args.message)
+julia> logger = FormatLogger() do io, log
+           println(io, log._module, " | ", "[", log.level, "] ", log.message)
        end;
 
 julia> with_logger(logger) do
@@ -49,12 +49,12 @@ function FormatLogger(formatter, path::AbstractString; append::Bool=false, kw...
 end
 
 function handle_message(logger::FormatLogger, args...; kwargs...)
-    log_args = handle_message_args(args...; kwargs...)
+    log = handle_message_args(args...; kwargs...)
     # We help the user by passing an IOBuffer to the formatting function
     # to make sure that everything writes to the logger io in one go.
     iob = IOBuffer()
     ioc = IOContext(iob, logger.stream)
-    logger.formatter(ioc, log_args)
+    logger.formatter(ioc, log)
     write(logger.stream, take!(iob))
     logger.always_flush && flush(logger.stream)
     return nothing

test/runtests.jl

@@ -201,23 +201,23 @@ Base.@kwdef struct BasicLogFormatter
     include_module::Bool=true
 end
 
-function (formatter::BasicLogFormatter)(io::IO, args::NamedTuple)
+function (formatter::BasicLogFormatter)(io::IO, log::NamedTuple)
     if formatter.include_module
-        print(io, args._module, " | ")
+        print(io, log._module, " | ")
     end
-    println(io, "[", args.level, "] ", args.message)
+    println(io, "[", log.level, "] ", log.message)
 end
 
 @testset "FormatLogger" begin
     io = IOBuffer()
-    logger = FormatLogger(io) do io, args
+    logger = FormatLogger(io) do io, log
         # Put in some bogus sleep calls just to test that
         # log records writes in one go
-        print(io, args.level)
+        print(io, log.level)
         sleep(rand())
         print(io, ": ")
         sleep(rand())
-        println(io, args.message)
+        println(io, log.message)
     end
     with_logger(logger) do
         @sync begin
@@ -242,7 +242,7 @@ end
     mktempdir() do dir
         f = joinpath(dir, "test.log")
 
-        logger = FormatLogger(f) do io, args
+        logger = FormatLogger(f) do io, log
             println(io, "log message")
         end