Remove examples with hard-wired input?
Open
@abirchfield is already working on this.
Since Apr 2, 2026.
new case
question
- Dominant language
- C++
- Stars
- 27
- Forks
- 11
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 23
Description
Question: Should we keep examples with hard-wired input i.e. 2-bus and 3-bus examples where inputs are not read from JSON input file but are hard-coded?
- Pros: The examples are informative of GridKit model assembly functionality and may be helpful for new developers to learn how the model assembly operates.
- Con: JSON input format is well tested and hard-wired examples are a small maintenance overhead. They may be misleading or confusing for some users who want to learn basic GridKit usage.
@nkoukpaizan
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.