Standardize config examples on KEY = VALUE - #389
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The updated config-format sentence incorrectly implies ! only starts full comment lines, but the parser supports inline ! comments (everything after ! is ignored).
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR standardizes the user-facing configuration examples in the SIPNET user guide to present a single canonical KEY = VALUE syntax, reducing ambiguity while keeping the underlying parser permissive.
Changes:
- Update the configuration file format description to emphasize
KEY = VALUE. - Convert precedence and phenology example snippets to
KEY = VALUEform. - Keep
sipnet.paramexamples whitespace-delimited as intended.
File summaries
| File | Description |
|---|---|
| docs/user-guide/running-sipnet.md | Standardizes config documentation/examples on KEY = VALUE syntax |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ### Configuration File Format | ||
|
|
||
| Each line in the configuration file contains a key-value pair. SIPNET accepts whitespace, `=`, or `:` between the key and value, and `!` starts a comment: | ||
| Each line in the configuration file uses KEY = VALUE syntax; ! starts a comment line. |
There was a problem hiding this comment.
@copilot Fix the code for all comments in this review comment.
When a review comment includes a suggested change, apply the suggestion exactly.
Do not make changes beyond what is described in the linked review comment.
There was a problem hiding this comment.
🔵 Needs a closer look
The updated documentation inaccurately states that ! only starts a comment line, but the parser supports inline/trailing comments (everything after ! is ignored).
Review details
Suppressed comments (1)
docs/user-guide/running-sipnet.md:97
- This sentence implies
!only starts a full comment line, but the parser strips everything after the first!on a line (inline/trailing comments are supported). Update wording so users know they can add comments after values.
Each line in the configuration file uses KEY = VALUE syntax; ! starts a comment line.
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
- Review effort level: Lite
Summary
KEY = VALUEsipnet.paramexamplesThe parser may remain permissive, but the user-facing documentation intentionally presents one canonical syntax to reduce unnecessary complexity.