Merge pull request #738 from direvus/prompt-wording

Audit prompt wording

detect_secrets/audit/audit.py

@@ -78,7 +78,7 @@ def _classify_secrets(iterator: BidirectionalIterator) -> bool:
         if decision == io.InputOptions.BACK:
             iterator.step_back_on_next_iteration()
 
-        # The question asked is: "Should this be committed to the repository?"
+        # The question asked is: "Should this string be committed to the repository?"
         elif decision == io.InputOptions.NO:
             secret.is_secret = True
             has_changes = True

detect_secrets/audit/io.py

@@ -130,7 +130,7 @@ def __init__(self, allow_labelling: bool, allow_backstep: bool) -> None:
 
     def __str__(self) -> str:
         if 'Y' in self.valid_input:
-            output = 'Is this a secret that should be committed to this repository?'
+            output = 'Should this string be committed to the repository?'
         else:
             output = 'What would you like to do?'
 

docs/audit.md

@@ -29,7 +29,7 @@ Secret Type: Secret Keyword
 68:      }
 69:    ],
 ----------
-Is this a secret that should be committed to this repository? (y)es, (n)o, (s)kip, (q)uit:
+Should this string be committed to the repository? (y)es, (n)o, (s)kip, (q)uit:
 ```
 
 There are two common cases for manual labelling:

tests/audit/io_test.py

@@ -12,7 +12,7 @@
                 'allow_backstep': True,
             },
             (
-                'Is this a secret that should be committed to this repository? '
+                'Should this string be committed to the repository? '
                 '(y)es, (n)o, (s)kip, (b)ack, (q)uit: '
             ),
         ),