aidotse / aidotse/behovskartan

Implement a more robust way of writing parameters.yaml

Open
#88 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

We currently use string replacement in parameters-template.yaml (e.g. {{SCENARIO_PROPERTIES}}), which preserves comments but lacks structure and validation.

Recommended options:
Use yaml (eemeli/yaml) AST library ✅

Preserves comments and formatting

Allows programmatic injection of schema blocks

Supports attaching inline comments via commentBefore

Use Handlebars templates 🟡

Preserves surrounding comments

Good for injecting dynamic blocks

Less robust for nested YAML editing

Use a parallel .comments.md or .yaml.comments.json file 🟢

Separates logic and documentation

Useful if generating OpenAPI for both code and docs

✳️ Recommended: Switch to the yaml library for AST-based injection while preserving comments inline.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.