From 14c23f7be365778d80892ae29760cea86ed931ce Mon Sep 17 00:00:00 2001
From: John Purnell <39587+jpcirrus@users.noreply.github.com>
Date: Mon, 12 Sep 2022 09:05:07 +0200
Subject: [PATCH] Document conditions for `suppress_history`

Closes #804
---
 docs/configuration/examples.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/configuration/examples.md b/docs/configuration/examples.md
index 8ecb287bf51..97cc94a7c4c 100644
--- a/docs/configuration/examples.md
+++ b/docs/configuration/examples.md
@@ -308,7 +308,13 @@ selected upon loading.
 
 tmuxp allows `suppress_history: false` to override the default command /
 suppression when building the workspace.
-This will add the `shell_command` to the bash history in the pane.
+This will add the `shell_command` to the shell history in the pane.
+The suppression of the `shell_command` commands from the shell's history
+occurs by prefixing the commands with a space when `suppress_history: true`.
+Accordingly, this functionality depends on the shell being appropriately
+configured: bash requires the shell variable `HISTCONTROL` to be set and
+include either of the values `ignorespace` or `ignoreboth` (to also ignore
+sequential duplicate commands), and zsh requires `setopt HIST_IGNORE_SPACE`.
 
 ````{tab} YAML