Comments (3)
The reason is that the docstring of @benchmark
(link) is a raw string (raw""" ... """
), hence (according to the manual) @doc
is required. I've just submitted a PR #203 that fixes this.
from benchmarktools.jl.
This is unfortunately also the "dead-end" point for the doc-strings of @btime
, @belapsed
, and @ballocated
, e.g.:
help?> @btime
@btime expression [other parameters...]
(...)
Unlike @time, it uses the @benchmark macro, and accepts all of the same additional
parameters as @benchmark. The printed time is the minimum elapsed time measured
during the benchmark.
help?> @benchmark
No documentation found.
I guess the relevant information is in manual.md; a question is whether some version of that could be copied more-or-less wholesale to the docstring.
from benchmarktools.jl.
There should probably be a linter that detects
raw"""
...
"""
function ...
...
end
and warns about the missing @doc
. Or even better, it should just work...
from benchmarktools.jl.
Related Issues (20)
- Automatically create keys in BenchmarkGroup
- Memory estimate?
- Re-edit docs for multiple setup
- Add logo? HOT 26
- Run docs examples during CI instead of copypasting outputs
- `tune!` on benchmarkable with evals set. HOT 4
- @benchmark creates new symbol for each interpolation of a symbol HOT 3
- Removing `leaves` export HOT 5
- Remember keyword parameters for `tune!` HOT 3
- [Feature Request] Comparing two functions HOT 1
- Memory leak when repeatedly benchmarking HOT 5
- is `@benchmarkset` usable ? HOT 1
- Tag non-breaking release of BenchmarkTools.jl? HOT 5
- Feature request: asynchronously build a benchmark group HOT 2
- Should hardcoded version number be updated?
- cannot read benchmark JSON if run & written with `seconds=Inf`
- `judge` lacks a docstring HOT 1
- `@btime` reports wrong allocation HOT 1
- timeout measures warmup (eliminating many of the reasons to use timeout) HOT 1
- @Benchmarkset fails silently, returns null HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from benchmarktools.jl.