Skip to content

Commit

Permalink
Merge pull request #2135 from CliMA/ck/doc_fixes
Browse files Browse the repository at this point in the history
Fix some DebugOnly docs
  • Loading branch information
charleskawczynski authored Jan 17, 2025
2 parents 86bdcf3 + d568895 commit dceaa19
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions src/DebugOnly/DebugOnly.jl
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ function example_debug_post_op_callback(result, args...; kwargs...)
end

"""
depth_limited_stack_trace([io::IO, ]st::Base.StackTraces.StackTrace; maxtypedepth=3)
depth_limited_stack_trace(
[io::IO, ]
st::Base.StackTraces.StackTrace;
maxtypedepth=3
)
Given a stacktrace `st`, return a vector of strings containing the trace with
depth-limited printing.
Expand All @@ -69,10 +73,14 @@ function type_depth_limit(io::IO, s::String; maxtypedepth::Union{Nothing, Int})
end

"""
depth_limited_stack_trace([io::IO, ]st::Base.StackTraces.StackTrace; maxtypedepth=3)
Given a stacktrace `st`, return a vector of strings containing the trace with
depth-limited printing.
print_depth_limited_stack_trace(
[io::IO, ]
st::Base.StackTraces.StackTrace;
maxtypedepth=3
)
Given a stacktrace `st`, print the stack trace with depth-limited types, given
by `maxtypedepth`.
"""
print_depth_limited_stack_trace(
st::Base.StackTraces.StackTrace;
Expand Down

0 comments on commit dceaa19

Please sign in to comment.