Skip to content

Commit 3829df7

Browse files
markdown lint fix
Signed-off-by: Jerry Guo <Jerry.Jinfeng.Guo@alliander.com>
1 parent 1051478 commit 3829df7

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/converters/vision_converter.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,13 @@ An examplery usage can be found in the example notebook as well as in the test c
9191

9292
## Optional extra columns
9393

94-
When working with Vision Excel exports, some metadata columns (like `GUID` or `StationID`) may not always be present, especially in partial exports.
95-
The `optional_extra` feature allows you to specify columns that should be included in `extra_info` if present, but won't cause conversion failure if missing.
94+
When working with Vision Excel exports, some metadata columns (like `GUID` or `StationID`) may not always be present,
95+
especially in partial exports.
96+
The `optional_extra` feature allows you to specify columns that should be included in `extra_info` if present,
97+
but won't cause conversion failure if missing.
9698

9799
**Syntax:**
100+
98101
```yaml
99102
grid:
100103
Transformers:
@@ -112,13 +115,14 @@ grid:
112115
```
113116
114117
**Behavior:**
118+
115119
- Required columns (listed directly under `extra`) will cause a KeyError if missing
116120
- Optional columns (nested under `optional_extra`) are silently skipped if not found
117121
- If some optional columns are present and others missing, only the present ones are included in `extra_info`
118122
- This feature is particularly useful for handling different Vision export configurations or versions
119123

120124
**Duplicate handling:**
121-
When a column appears in both the regular `extra` list and within `optional_extra`,
125+
When a column appears in both the regular `extra` list and within `optional_extra`,
122126
the regular `extra` entry takes precedence and duplicates are automatically eliminated from `optional_extra`:
123127

124128
```yaml
@@ -131,8 +135,10 @@ extra:
131135
- StationID # Unique optional - processed if present
132136
```
133137

134-
In this example, `ID` will only be processed once (from the regular `extra` list), while `GUID` and `StationID` are processed as optional columns.
135-
This prevents duplicate data in the resulting `extra_info` and ensures consistent behavior regardless of column ordering.
138+
In this example, `ID` will only be processed once (from the regular `extra` list),
139+
while `GUID` and `StationID` are processed as optional columns.
140+
This prevents duplicate data in the resulting `extra_info`
141+
and ensures consistent behavior regardless of column ordering.
136142

137143
## Common/Known issues related to Vision
138144

0 commit comments

Comments
 (0)