From 43c532bc577eb7169c5700fb42d74b805025ae66 Mon Sep 17 00:00:00 2001
From: Isaac <isaac@rubenfamily.com>
Date: Sat, 6 May 2023 11:51:35 -0700
Subject: [PATCH] add test for dedent strip

---
 borgmatic/commands/completion.py        |  4 ++++
 tests/unit/commands/test_completions.py | 10 ++++++++++
 2 files changed, 14 insertions(+)

diff --git a/borgmatic/commands/completion.py b/borgmatic/commands/completion.py
index d0ce745..4b2f17f 100644
--- a/borgmatic/commands/completion.py
+++ b/borgmatic/commands/completion.py
@@ -143,6 +143,10 @@ def exact_options_completion(action: Action):
 
 
 def dedent_strip_as_tuple(string: str):
+    '''
+    Dedent a string, then strip it to avoid requiring your first line to have content, then return a tuple of the string.
+    Makes it easier to write multiline strings for completions when you join them with a tuple.
+    '''
     return (dedent(string).strip('\n'),)
 
 
diff --git a/tests/unit/commands/test_completions.py b/tests/unit/commands/test_completions.py
index 7450277..69110af 100644
--- a/tests/unit/commands/test_completions.py
+++ b/tests/unit/commands/test_completions.py
@@ -5,6 +5,7 @@ from typing import Tuple
 import pytest
 
 from borgmatic.commands.completion import (
+    dedent_strip_as_tuple,
     exact_options_completion,
     has_choice_options,
     has_exact_options,
@@ -131,3 +132,12 @@ def test_produce_exact_options_completion(action: Action, option_type: OptionTyp
 
     except ValueError as value_error:
         assert False, f'exact_options_completion raised ValueError: {value_error}'
+
+
+def test_dedent_strip_as_tuple():
+    dedent_strip_as_tuple(
+        '''
+        a
+        b
+    '''
+    )