templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DOCs] Documented the error level for diff fail

This commit is contained in:
Salvador E. Tropea 2022-09-16 09:24:47 -03:00
parent 751e8e8c2f
commit 098b38c462
3 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -1683,6 +1683,7 @@ Notes:
- `pcb`: [boolean=true] Compare the PCB, otherwise compare the schematic. - `pcb`: [boolean=true] Compare the PCB, otherwise compare the schematic.
- `threshold`: [number=0] [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a - `threshold`: [number=0] [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a
difference bigger than the indicated value will make the diff fail. difference bigger than the indicated value will make the diff fail.
KiBot will return error level 29 and the diff generation will be aborted.
- `use_file_id`: [boolean=false] When creating the link name of an output file related to a variant use the variant - `use_file_id`: [boolean=false] When creating the link name of an output file related to a variant use the variant
`file_id` instead of its name. `file_id` instead of its name.
- `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. - `category`: [string|list(string)=''] The category for this output. If not specified an internally defined category is used.

3
docs/samples/generic_plot.kibot.yaml
View File

@ -496,7 +496,8 @@ outputs:
# [boolean=true] Compare the PCB, otherwise compare the schematic # [boolean=true] Compare the PCB, otherwise compare the schematic
pcb: true pcb: true
# [number=0] [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a # [number=0] [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a
# difference bigger than the indicated value will make the diff fail # difference bigger than the indicated value will make the diff fail.
# KiBot will return error level 29 and the diff generation will be aborted
threshold: 0 threshold: 0
# [boolean=false] When creating the link name of an output file related to a variant use the variant # [boolean=false] When creating the link name of an output file related to a variant use the variant
# `file_id` instead of its name # `file_id` instead of its name

3
kibot/out_diff.py
View File

@ -78,7 +78,8 @@ class DiffOptions(BaseOptions):
""" [0,100] Color tolerance (fuzzyness) for the `stats` mode """ """ [0,100] Color tolerance (fuzzyness) for the `stats` mode """
self.threshold = 0 self.threshold = 0
""" [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a """ [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a
difference bigger than the indicated value will make the diff fail """ difference bigger than the indicated value will make the diff fail.
KiBot will return error level 29 and the diff generation will be aborted """
self.add_link_id = False self.add_link_id = False
""" When enabled we create a symlink to the output file with a name that contains the """ When enabled we create a symlink to the output file with a name that contains the
git hashes involved in the comparison. If you plan to compress the output don't git hashes involved in the comparison. If you plan to compress the output don't