JuliaCI / JuliaCI/BenchmarkTools.jl

Document necessity to interpolate variables into top-level execution environment

Open
#111 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Julia
Stars
684
Forks
107
PR merge metrics
No merged PRs in 30d

Description

julia> [@elapsed n for n in 1:1]
1-element Array{Float64,1}:
 5.1e-8

julia> [@belapsed n for n in 1:1]
ERROR: UndefVarError: n not defined
Stacktrace:
 [1] ##core#667() at /Users/andreasnoack/.julia/v0.6/BenchmarkTools/src/execution.jl:316
 [2] ##sample#668(::BenchmarkTools.Parameters) at /Users/andreasnoack/.julia/v0.6/BenchmarkTools/src/execution.jl:322
 [3] #_run#10(::Bool, ::String, ::Array{Any,1}, ::Function, ::BenchmarkTools.Benchmark{Symbol("##benchmark#666")}, ::BenchmarkTools.Parameters) at /Users/andreasnoack/.julia/v0.6/BenchmarkTools/src/execution.jl:350
 [4] (::BenchmarkTools.#kw##_run)(::Array{Any,1}, ::BenchmarkTools.#_run, ::BenchmarkTools.Benchmark{Symbol("##benchmark#666")}, ::BenchmarkTools.Parameters) at ./<missing>:0
 [5] anonymous at ./<missing>:?
 [6] #run_result#19(::Array{Any,1}, ::Function, ::BenchmarkTools.Benchmark{Symbol("##benchmark#666")}, ::BenchmarkTools.Parameters) at /Users/andreasnoack/.julia/v0.6/BenchmarkTools/src/execution.jl:44
 [7] (::BenchmarkTools.#kw##run_result)(::Array{Any,1}, ::BenchmarkTools.#run_result, ::BenchmarkTools.Benchmark{Symbol("##benchmark#666")}, ::BenchmarkTools.Parameters) at ./<missing>:0
 [8] #run#21(::Array{Any,1}, ::Function, ::BenchmarkTools.Benchmark{Symbol("##benchmark#666")}, ::BenchmarkTools.Parameters) at /Users/andreasnoack/.julia/v0.6/BenchmarkTools/src/execution.jl:67
 [9] (::Base.#kw##run)(::Array{Any,1}, ::Base.#run, ::BenchmarkTools.Benchmark{Symbol("##benchmark#666")}, ::BenchmarkTools.Parameters) at ./<missing>:0 (repeats 2 times)
 [10] (::##8#9)(::Int64) at /Users/andreasnoack/.julia/v0.6/BenchmarkTools/src/execution.jl:234
 [11] collect(::Base.Generator{UnitRange{Int64},##8#9}) at ./array.jl:470

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Julia examples in the issue and inspect the repository's existing documentation for the section covering @belapsed interpolation and top-level execution. Done means documenting why interpolation is necessary and capturing the contrast with @elapsed shown in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.