warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add syntax description

Browse Source
This commit is contained in:
Tobias Falk 2025-03-12 22:01:48 +01:00
parent 01c3771a9c
commit 203e947293
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/syntax.md
View File

@ -83,8 +83,24 @@ tweak: # optional tweaking of .gv output
hide_disconnected_pins: <bool> # defaults to false
# loops
loops: <List> # every list item is itself a list of exactly two pins
# on the connector that are to be shorted
loops: # a list(dict) of loops
- <str>: <List> # every list item is itself a list of pins
# on the connector that are to be shorted with a cable loop
# more information about the loop can be added by additional
# components definition (see below)
# OR
- <List> # a list of pins to be looped
# Shorts
shorts: # a list(dict) of shorts
<str>: <List> # every list item is itself a list of pins
# on the connector that are to be shorted represented inside
# the connector table
# more information about the loop can be added by additional
# components definition (see below)
# OR
- <List> # a list of pins to be shorted
# it is not posable to combine those two
shorts_hide_lable: <bool> # A Boolean to control if the lable of the shorts should be shown, if a list is used this is automatically turned true.
```
## Cable attributes