Merge branch 'pv-alloc-profile-docs-feedback' into pv-alloc-profile-docs

vilterp · Jan 7, 2022 · 5dc2beb · 5dc2beb
2 parents 4fec8dd + 9a4b7fb
commit 5dc2beb
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/stdlib/Profile/docs/src/index.md b/stdlib/Profile/docs/src/index.md
@@ -27,8 +27,8 @@ Profile.Allocs.@profile
 The methods in `Profile.Allocs` are not exported and need to be called e.g. as `Profile.Allocs.fetch()`.
 
 ```@docs
-Profile.Allocs.start
-Profile.Allocs.stop
 Profile.Allocs.clear
 Profile.Allocs.fetch
+Profile.Allocs.start
+Profile.Allocs.stop
 ```
diff --git a/stdlib/Profile/src/Allocs.jl b/stdlib/Profile/src/Allocs.jl
@@ -33,7 +33,7 @@ end
 Profile allocations that happen during `expr`, returning
 both the result and and AllocResults struct.
 
-A sample rate of 1 will record everything; 0 will record nothing.
+A sample rate of 1.0 will record everything; 0.0 will record nothing.
 
 ```julia
 julia> Profile.Allocs.@profile sample_rate=0.01 peakflops()
@@ -62,12 +62,12 @@ function _prof_expr(expr, opts)
 end
 
 """
-    Profile.Allocs.start(sample_rate::Number)
+    Profile.Allocs.start(sample_rate::Real)
 
 Begin recording allocations with the given sample rate
-A sample rate of 1 will record everything; 0 will record nothing.
+A sample rate of 1.0 will record everything; 0.0 will record nothing.
 """
-function start(; sample_rate::Number)
+function start(; sample_rate::Real)
     ccall(:jl_start_alloc_profile, Cvoid, (Cdouble,), Float64(sample_rate))
 end
 
@@ -83,7 +83,7 @@ end
 """
     Profile.Allocs.clear()
 
-Clear allocation information from memory.
+Clear all previously profiled allocation information from memory.
 """
 function clear()
     ccall(:jl_free_alloc_profile, Cvoid, ())