NatLabRockies / NatLabRockies/GridAnalysisToolkit

Gallery pages embed warning/stderr blocks from example execution

Open
#19 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Most gallery pages (01–09) render a captured stderr block above their figures — tech-mapping fuzzy-match warnings, missing-dataset warnings, etc., complete with build-machine file paths (CI runner paths in the deployed docs). It's noise that makes polished examples look broken.

Two-level fix:

  1. Cosmetic: examples silence expected warnings (the new example 10 does this deliberately for the fixture's missing-storage warnings) or sphinx-gallery is configured to not capture stderr.
  2. Root cause: some of these warnings are telling us something (e.g. technologies missing from standard mappings for the fixture) — fixing the fixture's palette/mapping coverage removes the warning honestly instead of hiding it.

Related: #14 (gallery rendering defects) — same audit pass could cover both.

Also noted while building: MultiScenario's pass-through getters (get_area_dispatch() etc.) accept no kwargs, so per-scenario options like include_charging=False can't be forwarded — a small API gap worth fixing alongside.

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 reviewing gallery pages 01–09 and the warning-silencing approach used by example 10, then compare the related rendering defects in #14. Trace the fixture palette/mapping warnings before deciding whether they should be fixed or suppressed. Separately inspect MultiScenario's pass-through getters and verify whether per-scenario kwargs can be forwarded; done means the gallery output is clean and the API gap is addressed without hiding meaningful warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.