Skip to content

Commit

Permalink
alloc profiler: add compat note to docstring (JuliaLang#44100)
Browse files Browse the repository at this point in the history
  • Loading branch information
vilterp authored and antoine-levitt committed Feb 17, 2022
1 parent fb3509e commit 8057173
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions stdlib/Profile/src/Allocs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,17 @@ julia> last(sort(results.allocs, by=x->x.size))
Profile.Allocs.Alloc(Vector{Any}, Base.StackTraces.StackFrame[_new_array_ at array.c:127, ...], 5576)
```
Note: The current implementation of the Allocations Profiler _does not
capture types for all allocations._ Allocations for which the profiler
could not capture the type are represented as having type
`Profile.Allocs.UnknownType`.
!!! note
The current implementation of the Allocations Profiler does not
capture types for all allocations. Allocations for which the profiler
could not capture the type are represented as having type
`Profile.Allocs.UnknownType`.
You can read more about the missing types and the plan to improve this, here:
https://github.com/JuliaLang/julia/issues/43688.
You can read more about the missing types and the plan to improve this, here:
https://github.com/JuliaLang/julia/issues/43688.
!!! compat "Julia 1.8"
The allocation profiler was added in Julia 1.8.
"""
macro profile(opts, ex)
_prof_expr(ex, opts)
Expand Down

0 comments on commit 8057173

Please sign in to comment.