From 203e947293439deaba42b7240e205afdf7b0c753 Mon Sep 17 00:00:00 2001 From: Tobias Falk Date: Wed, 12 Mar 2025 22:01:48 +0100 Subject: [PATCH] Add syntax description --- docs/syntax.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/syntax.md b/docs/syntax.md index 77fce9a..47bc1b5 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -83,8 +83,24 @@ tweak: # optional tweaking of .gv output hide_disconnected_pins: # defaults to false # loops - loops: # 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 + - : # 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 + - # a list of pins to be looped + # Shorts + shorts: # a list(dict) of shorts + : # 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 + - # a list of pins to be shorted + # it is not posable to combine those two + shorts_hide_lable: # 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