Skip to content

Commit 17c6f9c

Browse files
author
karei
committed
docs: update logger API docstrings
1 parent 0d1f8cd commit 17c6f9c

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

src/docstrings.jl

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -95,51 +95,52 @@ Example:
9595
:(@bind_logger)
9696

9797
"""
98-
clog(logger, [group], level, msg...; _module, file, line, kwargs...)
98+
clog(logger, group, level, msg...; _module, file, line, kwargs...)
9999
100100
Emit a log message through the given or implicit logger. `group` is a `Symbol`
101-
or `NTuple{N,Symbol}`. If omitted, the default group `(DEFAULT_SYM,)` is used.
102-
`level` may be `LogLevel` or `Integer`. `msg` can be one or more values; tuples
103-
are passed through as-is.
101+
or `NTuple{N,Symbol}`. `level` may be `LogLevel` or `Integer`. `msg` can be one
102+
or more values; tuples are passed through as-is.
104103
105104
Keyword arguments `file`, `line`, and arbitrary `kwargs...` are forwarded to the
106105
underlying logger sink.
107106
108-
It is recommended to create a forwarding function to implicitly pass the logger:
107+
If `@forward_logger` is already used, the following forwarding signatures are available:
109108
110109
```julia
111-
clog(args...; kwargs...) = clog(logger, args...; kwargs...)
110+
clog(group, level, msg...; kwargs...)
111+
clog(group, msg...; kwargs...)
112112
```
113113
"""
114114
clog
115115

116116
"""
117-
clogenabled(logger, [group], level) -> Bool
117+
clogenabled(logger, group, level) -> Bool
118118
clogenabled(logger, group) -> Bool
119119
120-
Return whether logging is enabled for the given `group` and `level` using the
121-
given or implicit module-bound logger.
120+
Return whether logging is enabled for the given `logger`, `group`, and `level`.
121+
If `level` is omitted, `Info` is used.
122122
123-
It is recommended to create a forwarding function to implicitly pass the logger:
123+
If `@forward_logger` is already used, the following forwarding signatures are available:
124124
125125
```julia
126-
clogenabled(group, level) = clogenabled(logger, group, level)
126+
clogenabled(group, level) -> Bool
127+
clogenabled(group) -> Bool
127128
```
128129
"""
129130
clogenabled
130131

131132
"""
132-
clogf(f::Function, logger, [group], level; _module, file, line)
133+
clogf(f::Function, logger, group, level; _module, file, line)
133134
134135
Like `clog`, but accepts a zero-argument function `f` that is only invoked if
135136
logging is enabled for the specified `group` and `level`. If `f()` returns
136137
`nothing`, no message is emitted. Non-tuple returns are converted to a tuple
137138
internally.
138139
139-
It is recommended to create a forwarding function to implicitly pass the logger:
140+
If `@forward_logger` is already used, the following forwarding signatures are available:
140141
141142
```julia
142-
clogf(f, group, level; kwargs...) = clogf(f, logger, group, level; kwargs...)
143+
clogf(f, group, level; _module, file, line)
143144
```
144145
"""
145146
clogf

0 commit comments

Comments
 (0)