[DOCs][Updated] Defaults that promote dict -> list(dict)

INTI-CMNB · Aug 7, 2024 · 15729fc · 15729fc
1 parent a443ed5
commit 15729fc
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml
@@ -1781,7 +1781,7 @@ outputs:
     type: 'kikit_present'
     dir: 'Example/kikit_present_dir'
     options:
-      # [dict|list(dict)={}] One or more boards that compose your project.
+      # [dict|list(dict)=[{}]] One or more boards that compose your project.
       # When empty we will use only the main PCB for the current project
       boards:
         # [string=''] How to obtain the back view of the PCB.
@@ -3323,7 +3323,7 @@ outputs:
       # [string='%f-%i%I%v.%x'] Filename/dirname for the output library (%i=qr, %x=lib/kicad_sym/pretty).
       # You must use %x in the name to get a symbols lib and a footprints lib. Affected by global options
       output: '%f-%i%I%v.%x'
-      # [dict|list(dict)={}] QR codes to include in the library
+      # [dict|list(dict)=[{}]] QR codes to include in the library
       qrs:
         # [string='low'] [low,medium,quartile,high] Error correction level
         - correction_level: 'low'

diff --git a/docs/source/configuration/outputs/kikit_present.rst b/docs/source/configuration/outputs/kikit_present.rst
@@ -30,7 +30,7 @@ Parameters:
          You can embed the markdown code. If the text doesn't map to a file and contains
          more than one line KiBot will assume this is the markdown.
          If empty KiBot will generate a silly text and a warning.
-      -  ``boards`` :index:`: <pair: output - kikit_present - options; boards>` [:ref:`dict <dict>` | :ref:`list(dict) <list(dict)>`] (default: empty dict, default values used) One or more boards that compose your project.
+      -  ``boards`` :index:`: <pair: output - kikit_present - options; boards>` [:ref:`dict <dict>` | :ref:`list(dict) <list(dict)>`] (default: list with one empty dict, default values used) One or more boards that compose your project.
          When empty we will use only the main PCB for the current project.
 
          -  Valid keys:

diff --git a/docs/source/configuration/outputs/qr_lib.rst b/docs/source/configuration/outputs/qr_lib.rst
@@ -32,7 +32,7 @@ Parameters:
       -  **lib** :index:`: <pair: output - qr_lib - options; lib>` [:ref:`string <string>`] (default: ``'QR'``) Short name for the library.
       -  **output** :index:`: <pair: output - qr_lib - options; output>` [:ref:`string <string>`] (default: ``'%f-%i%I%v.%x'``) Filename/dirname for the output library (%i=qr, %x=lib/kicad_sym/pretty).
          You must use %x in the name to get a symbols lib and a footprints lib. Affected by global options.
-      -  **qrs** :index:`: <pair: output - qr_lib - options; qrs>` [:ref:`dict <dict>` | :ref:`list(dict) <list(dict)>`] (default: empty dict, default values used) QR codes to include in the library.
+      -  **qrs** :index:`: <pair: output - qr_lib - options; qrs>` [:ref:`dict <dict>` | :ref:`list(dict) <list(dict)>`] (default: list with one empty dict, default values used) QR codes to include in the library.
 
          -  Valid keys:
 

diff --git a/kibot/config_reader.py b/kibot/config_reader.py
@@ -806,6 +806,8 @@ def process_help_data_type(obj, help, v):
             new_data_type += ' (default: computed for your project)'
         elif def_val == '{}':
             new_data_type += ' (default: empty dict, default values used)'
+        elif def_val == '[{}]':
+            new_data_type += ' (default: list with one empty dict, default values used)'
         else:
             new_data_type += f' (default: ``{def_val}``)'
     elif isinstance(v, type):