Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide longer names #122

Open
LilithHafner opened this issue Sep 14, 2024 · 4 comments
Open

Provide longer names #122

LilithHafner opened this issue Sep 14, 2024 · 4 comments

Comments

@LilithHafner
Copy link
Owner

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)

@Tortar
Copy link

Tortar commented Sep 14, 2024

I vote C. because it seems the clearest and not-too-verbose alternative and I like the pun ;-)

@Tortar
Copy link

Tortar commented Sep 14, 2024

what about also (manipulated suggestion from the other options in #100) D. @minbench and @fullbench? Seem like not too verbose to me, and the macros are different from BenchmarkTools

@alfaromartino
Copy link

alfaromartino commented Sep 16, 2024

I like @minbench and @fullbench more, although I'd suggest @minibench or @litebench for the former. They keep clarity, while keeping conciseness.
Note that @bench and @benchmark are problematic for tab completion, as they start with the same letters.

@ajinkya-k
Copy link

ajinkya-k commented Dec 29, 2024

why not @chair and @chairmark respectively? This makes sure that the names don't clash with BenchmarkTools macros, and is true to the package name!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants