Skip to content

Commit

Permalink
start to expand docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IanButterworth committed Oct 14, 2024
1 parent 83b4487 commit f7d3e8b
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion base/timing.jl
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,9 @@ A macro to execute an expression, printing the time it took to execute, the numb
allocations, and the total number of bytes its execution caused to be allocated, before
returning the value of the expression. Any time spent garbage collecting (gc), compiling
new code, or recompiling invalidated code is shown as a percentage. Any lock conflicts
where a [`ReentrantLock`](@ref) had to wait are shown as a count.
where a [`ReentrantLock`](@ref) had to wait are shown as a count. If the time spent on
scheduling tasks (not including sleeping/waiting) is more than 10% of the total time it
is also shown as a percentage.
Optionally provide a description string to print before the time report.
Expand All @@ -317,6 +319,9 @@ See also [`@showtime`](@ref), [`@timev`](@ref), [`@timed`](@ref), [`@elapsed`](@
!!! compat "Julia 1.11"
The reporting of any lock conflicts was added in Julia 1.11.
!!! compat "Julia 1.12"
The reporting of excessive scheduling time was added in Julia 1.12.
```julia-repl
julia> x = rand(10,10);
Expand Down

0 comments on commit f7d3e8b

Please sign in to comment.