llnl / llnl/Caliper

Request for get_config_docstrings to also decorate default configuration settings

Open
#252 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
420
Forks
80
Avg merge
1d 12h
Merged PRs (30d)
9

Description

For messages with true or false values, it would be nice if get_config_docstrings could add decorations to signify current setting versus default settings where possible.

For example, something like this would be handy:

profile.cuda=true(D)|false: Profile CUDA API functions (e.g., cudaMalloc)

(D) - Default setting

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating get_config_docstrings and inspect how it formats true and false configuration values and distinguishes current settings from defaults. Done means boolean settings can display a default marker such as (D), with the existing configuration description preserved; the issue names no specific file or test to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
performance
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.