docs: add field types and fix value-condition bug in user guide#148
Open
aoustry wants to merge 1 commit into
Open
docs: add field types and fix value-condition bug in user guide#148aoustry wants to merge 1 commit into
aoustry wants to merge 1 commit into
Conversation
Add an explicit Type column to all field tables in library.md, system.md,
data-series.md, and scenario-builder.md so readers can see at a glance
whether a field accepts a String, Boolean, Enum, Number, or Mathematical
Expression — following the style already used in solver-optimization.md.
Also:
- Document the missing `version` field in the library header (present in
all real library YAMLs but absent from the docs).
- Fix an inverted condition in system.md: the `value` field is a number
when BOTH time-dependent and scenario-dependent are false, not when
scenario-dependent is true.
- Add a top-level field table to system.md (id, description,
model-libraries, components, connections).
- Add a token-type table to scenario-builder.md.
- Fix a copy-paste error in data-series.md ("scenario 2 is 60, 22").
- Clarify that data series cell values are floating-point numbers.
https://claude.ai/code/session_01PAxkYgxjnRiunwbpHmxdgL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add an explicit Type column to all field tables in library.md, system.md,
data-series.md, and scenario-builder.md so readers can see at a glance
whether a field accepts a String, Boolean, Enum, Number, or Mathematical
Expression — following the style already used in solver-optimization.md.
Also:
versionfield in the library header (present inall real library YAMLs but absent from the docs).
valuefield is a numberwhen BOTH time-dependent and scenario-dependent are false, not when
scenario-dependent is true.
model-libraries, components, connections).
https://claude.ai/code/session_01PAxkYgxjnRiunwbpHmxdgL