Skip to content

Commit 7a8471b

Browse files
authored
Fix some references and docstrings. (#55)
1 parent 3dfec54 commit 7a8471b

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

src/activefiltered.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `filter` should be a function that returns a boolean.
1717
`true` if the message should be logged and `false` if not.
1818
As input it will be given a named tuple with the following fields:
1919
`(level, message, _module, group, id, file, line, kwargs)`
20-
See `?LoggingExtra.handle_message_args` for more information on what each is.
20+
See [`LoggingExtras.handle_message_args`](@ref) for more information on what each is.
2121
"""
2222
struct ActiveFilteredLogger{T <: AbstractLogger, F} <: AbstractLogger
2323
filter::F

src/datetime_rotation.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using Dates
22

3-
raw"""
3+
@doc raw"""
44
DatetimeRotatingFileLogger(dir, file_pattern; always_flush=true, rotation_callback=identity)
55
DatetimeRotatingFileLogger(f::Function, dir, file_pattern; always_flush=true, rotation_callback=identity)
66
@@ -17,7 +17,7 @@ It is possible to pass a formatter function as the first argument to control the
1717
The formatting function should be of the form `f(io::IOContext, log_args::NamedTuple)`
1818
where `log_args` has the following fields:
1919
`(level, message, _module, group, id, file, line, kwargs)`.
20-
See `?LoggingExtra.handle_message_args` for more information about what each field represents.
20+
See [`LoggingExtras.handle_message_args`](@ref) for more information about what each field represents.
2121
2222
It is also possible to pass `rotation_callback::Function` as a keyword argument. This function
2323
will be called every time a file rotation is happening. The function should accept one

src/earlyfiltered.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The `filter` should be a function that returns a boolean.
1313
`true` if the message should be logged and `false` if not.
1414
As input it will be given a named tuple with the following fields:
1515
`(level, _module, group, id)`
16-
See `?LoggingExtra.shouldlog_args` for more information on what each is.
16+
See [`LoggingExtras.shouldlog_args`](@ref) for more information on what each is.
1717
"""
1818
struct EarlyFilteredLogger{T <: AbstractLogger, F} <: AbstractLogger
1919
filter::F

src/formatlogger.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Logger sink that formats the message and finally writes to `io`.
1212
The formatting function should be of the form `f(io::IOContext, log_args::NamedTuple)`
1313
where `log_args` has the following fields:
1414
`(level, message, _module, group, id, file, line, kwargs)`.
15-
See `?LoggingExtra.handle_message_args` for more information on what field is.
15+
See [`LoggingExtras.handle_message_args`](@ref) for more information on what field is.
1616
1717
# Examples
1818
```julia-repl

src/transformer.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ to conditionally change the log level of logs from a given module
99
The transforming function `f` is given a named tuple with the fields:
1010
`(level, message, _module, group, id, file, line, kwargs)`
1111
and should return the same.
12-
See `?LoggingExtra.handle_message_args` for more information on what each is.
12+
See [`LoggingExtras.handle_message_args`](@ref) for more information on what each is.
1313
"""
1414
struct TransformerLogger{T<:AbstractLogger, F} <: AbstractLogger
1515
transform::F

0 commit comments

Comments
 (0)