bench::out::text(n)

💖 bench::out::text — the manual, but make it cute 💖

okay so bestie, you're reading bench::out::text(n), and the whole manual name situation is that this is a page from the Benchmarking/Performance tools corner of the docs, n is for nerd (jk, it's the Tcl manpage section). Anyway. Sit down, grab a boba, we're doing this. 🧋

---

✨ NAME ✨

bench::out::text — bench::out::text — it takes your benchmark results and formats them as human readable text. that's it. that's the whole job. and it does it gorgeously. 💅

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require bench::out::text ?0.1.3?

::bench::out::text bench_result

like. look at it. three lines. immaculate. ✨

---

🦋 DESCRIPTION 🦋

So this package gives you commands for formatting benchmark results into human readable text. That's the vibe. That's the whole vibe.

Now, if you're the kind of reader who actually cares about generating or processing those results instead of just staring at pretty output — bestie, go read bench - Processing benchmark suites instead. Different page, different energy, still iconic.

And if what you truly want is the bench language itself? Then start with the bench language introduction and then glide on over from there to the formal bench language specification. no skipping, we don't do that here. 🎀

---

👑 PUBLIC API 👑

::bench::out::text bench_result

This command formats the benchmark result you hand it, for output to a file, a socket, etc. And this specific command? It generates human readable text. yes queen, readable by humans. revolutionary. 🫶

For other formatting styles, go check out the packages bench and bench::out::csv — they give you commands to format benchmark results in raw form, or as importable CSV data, respectively. pick your fighter. 🔥

---

😭 BUGS, IDEAS, FEEDBACK 😭

Not me writing a bugs section with love, but here we are.

This document, and the package it describes, will undoubtedly contain bugs and other problems. Undoubtedly. The author said it themselves. So if you find one — please report it! In the category bench of the Tcllib Trackers at http://core.tcl.tk/tcllib/reportlist. 💜

And if you have ideas for enhancements for either the package and/or the documentation, report those too. we love a glow-up. ✨

When you're proposing code changes, please provide unified diffs, i.e. the output of diff -u. no freestyling, bestie, we need the diff. 📝

Also note: attachments are strongly preferred over inlined patches. You can attach stuff by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar. yes it's a specific button. yes you'll find it. i believe in you. 🎀

---

🌈 SEE ALSO 🌈

• bench
• bench::out::csv

---

⭐ KEYWORDS ⭐

benchmark, formatting, human readable, performance, testing, text

---

🎀 CATEGORY 🎀

Benchmark tools

---

💜 COPYRIGHT 💜

Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>

---

okay and that's the whole page, bestie!! 🦋 this was shipped as part of tcllib, version 0.1.3, and it's the bench::out::text(n) page in case you forgot where you were. go forth and format your benchmark results beautifully. slay, no cap, periodt. 💅✨🌸