Skip to content

Provide longer names #122

@LilithHafner

Description

@LilithHafner

As Charimarks.jl has gained popularity and started to get used outside of the REPL, it makes sense to move to longer names for @b and @be.

What sort of longer names do folks want?

A. @btime/@benchmark does not make sense because @b, unlike BencharmkTools.@btime, neither prints runtime data nor returns the evaluation result
B. @benchmark_summary/@benchmark_full works, though very verbose, and precludes adding an even more informative version that saves more data
C. @bench/@benchmark is fun and silly and concise while still being clear that we're benchmarking. It still relies on the pun: shorter name = shorter results.


I would implement this by adding long names as an option and then maybe deprecating the use of short names in packages and scripts. I do not currently plan to deprecate the use of short names at the REPL.

Alternatively, I could export the long names and publicize the short alternatives, like Unitful.

Originally posted by @LilithHafner in #100 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions