daphne-project/daphne

Add option to specify amount of statistics displayed with --statistics

Open

#738 opened on May 29, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (84 forks)auto 404
good first issue

Repository metrics

Stars
 (80 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, --statistics displays up to a fixed amount of of lines as output, this is hardcoded at 10, see here.

We would like to give the user of daphne an option to specify the upper limit of displayed statistics. Preferably, the --statistics command still works without any change, and in addition to that one could specify a number, e.g., --statistics=20 or --statistics 20.

Contributor guide

Research direction
Locate the Statistics.h file at src/util/Statistics.h. The constant for the maximum number of statistics lines is defined there (likely `MAX STATISTICS` or similar). Modify the constant to be configurable via a command line argument. Update the argument parser (likely in src/util/CLI11.h or similar) to accept an optional integer value for statistics. Ensure that statistics without a value still defaults to the original behavior (10 lines). Update the statistics display function to use the user specified limit. Test the changes.
Tech stack
cpp
Domain
backend
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75