Code Monkey home page Code Monkey logo

Comments (3)

FedericoStra avatar FedericoStra commented on May 22, 2024 1

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.

thchr avatar thchr commented on May 22, 2024

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.

FedericoStra avatar FedericoStra commented on May 22, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.