From 460ffca49b68cdb50e764688d35274cf5b18e4de Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Mon, 5 Sep 2022 13:56:56 -0300 Subject: [PATCH] [Diff] Better `copy_instead_of_link` description Related to #275 --- README.md | 4 ++-- docs/samples/generic_plot.kibot.yaml | 4 ++-- kibot/out_diff.py | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8a05453f..4420e5b2 100644 --- a/README.md +++ b/README.md @@ -1508,8 +1508,8 @@ Notes: git hashes involved in the comparison. If you plan to compress the output don't forget to disable the `follow_links` option. - `cache_dir`: [string=''] Directory to cache the intermediate files. Leave it blank to disable the cache. - - `copy_instead_of_link`: [boolean=false] When `add_link_id` is enabled creates a copy of the file instead of a symlink. - Useful for some Windows setups. + - `copy_instead_of_link`: [boolean=false] Modifies the behavior of `add_link_id` to create a copy of the file instead of a + symlink. Useful for some Windows setups. - `diff_mode`: [string='red_green'] [red_green,stats] In the `red_green` mode added stuff is green and red when removed. The `stats` mode is used to meassure the amount of difference. In this mode all changes are red, but you can abort if the difference is bigger than certain threshold. diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 13fd73a7..0029e6fd 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -422,8 +422,8 @@ outputs: add_link_id: false # [string=''] Directory to cache the intermediate files. Leave it blank to disable the cache cache_dir: '' - # [boolean=false] When `add_link_id` is enabled creates a copy of the file instead of a symlink. - # Useful for some Windows setups + # [boolean=false] Modifies the behavior of `add_link_id` to create a copy of the file instead of a + # symlink. Useful for some Windows setups copy_instead_of_link: false # [string='red_green'] [red_green,stats] In the `red_green` mode added stuff is green and red when removed. # The `stats` mode is used to meassure the amount of difference. In this mode all diff --git a/kibot/out_diff.py b/kibot/out_diff.py index 12c6eee6..5f67d02e 100644 --- a/kibot/out_diff.py +++ b/kibot/out_diff.py @@ -74,8 +74,8 @@ class DiffOptions(BaseOptions): git hashes involved in the comparison. If you plan to compress the output don't forget to disable the `follow_links` option """ self.copy_instead_of_link = False - """ When `add_link_id` is enabled creates a copy of the file instead of a symlink. - Useful for some Windows setups """ + """ Modifies the behavior of `add_link_id` to create a copy of the file instead of a + symlink. Useful for some Windows setups """ self.force_checkout = False """ When `old_type` and/or `new_type` are `git` KiBot will checkout the indicated point. Before doing it KiBot will stash any change. Under some circumstances git could fail