bencheeorg/benchee

Add option for displaying long labels for scaled units

Open

#28 opened on Sep 18, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Elixir (1,509 stars) (69 forks)batch import
Hacktoberfestenhancementgood first issue

Description

For example, display 1.23 Million instead of 1.23M.

This should be an option unit_label with possible values :short and :long defaulting to short. It can then be picked up by the different formatters, in the first version just the console formatter to display long names or short names.

edit (@PragTob) : changed to be a general option and not just for the console

Contributor guide

Tech stack
elixir
Domain
clitoolingperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Elixir programmingbenchee library internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing configuration structure in Benchee to understand where to add the new `unit label` option. Look at the console formatter code (likely in `lib/benchee/formatters/console.ex`) to see how scaled unit labels are currently generated. Implement the `:long` option by mapping unit abbreviations to full names (e.g., 'M' > 'Million'). Then update the formatter to check the option and use long names when appropriate.