llnl / llnl/conduit

strategy to reduce noise in generated output consumed by doc builds

Open
#620 0 comments 0 reactions 0 assignees View on GitHub
docs
Dominant language
C++
Stars
248
Forks
72
Avg merge
1d 16h
Merged PRs (30d)
15

Description

Things like file system paths, ctest test numbers, runtimes, addresses (in some cases -- but some are important!) can contrib noise to the review process for examples.

See discussion here:

https://github.com/LLNL/conduit/pull/617

think about if/how we could clean the output to reduce noise.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the discussion in PR #617 and inspect the generated example output consumed by the documentation builds, focusing on paths, ctest numbers, runtimes, and addresses. Define which values are noise versus important output and document a concrete approach whose effect can be reviewed in the generated examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.