From 6a729cc8a9192efca8dd92be740a9b9146f7dda6 Mon Sep 17 00:00:00 2001
From: Alexander Barton <alex@barton.de>
Date: Sat, 8 Jul 2017 23:17:38 +0200
Subject: [PATCH] Add and streamline comments for prompt variables

---
 core/90_theme/90_theme.zshrc | 2 ++
 themes/ax.axzshtheme         | 6 +++---
 themes/axemoji.axzshtheme    | 4 +++-
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/core/90_theme/90_theme.zshrc b/core/90_theme/90_theme.zshrc
index a6325c2..084d2f3 100644
--- a/core/90_theme/90_theme.zshrc
+++ b/core/90_theme/90_theme.zshrc
@@ -1,6 +1,8 @@
 # AX-ZSH: Alex' Modular ZSH Configuration
 # 90_theme.zshrc: Load AX-ZSH theme
 
+# Read in the theme configuration.
 [[ -n "$AXZSH_THEME" ]] && source "$AXZSH_THEME"
 
+# RPS1 will cause trouble on "dumb" terminals; so reset it there!
 axzsh_is_dumb_terminal && unset RPS1
diff --git a/themes/ax.axzshtheme b/themes/ax.axzshtheme
index df8b056..b04dc4a 100644
--- a/themes/ax.axzshtheme
+++ b/themes/ax.axzshtheme
@@ -12,15 +12,15 @@ ZSH_THEME_PROMPT_SUFFIX_SPACING=" "
 ax_logname_prompt_functions=($ax_logname_prompt_functions ax_logname_prompt_root)
 ax_hostname_prompt_functions=($ax_hostname_prompt_functions ax_hostname_prompt_root)
 
-# Default prompt
+# The primary prompt string, printed before a command is read.
 PS1="$(ax_logname_prompt_yn)$(ax_hostname_prompt_yn)%B%2~%b"'$(ax_vcs_prompt)'"$(ax_prompt)"
 
-# Prompt on right side
+# Primary prompt on the right-hand side.
 axzsh_is_widechar_terminal \
 	&& RPS1="%(?..%{$fg_no_bold[red]%}%? ↵%{$reset_color%})" \
 	|| RPS1="%(?..%{$fg_no_bold[red]%}<%?>%{$reset_color%})"
 
-# Execution trace prompt.
+# Default execution trace prompt.
 PS4="$fg_no_bold[yellow]->$reset_color "
 # This prompt is compatible with sh(1) and bash(1), too, so export it!
 export PS4
diff --git a/themes/axemoji.axzshtheme b/themes/axemoji.axzshtheme
index 128b4cd..4a54a6d 100644
--- a/themes/axemoji.axzshtheme
+++ b/themes/axemoji.axzshtheme
@@ -20,16 +20,18 @@ if axzsh_is_widechar_terminal; then
 	ZSH_THEME_VCS_PROMPT_CLEAN="👌$emoji_spacing"
 	ZSH_THEME_VCS_PROMPT_DIRTY="👻$emoji_spacing"
 
-	# Prompt on right side
+	# Primary prompt on the right-hand side.
 	RPS1="%(?..%{$fg_no_bold[red]%}❌$emoji_spacing%? ↵%{$reset_color%})"
 else
 	# Non-UTF8 or incompatible terminal
 	system_emoji=">"
 	emoji_spacing=""
 
+	# Primary prompt on the right-hand side.
 	RPS1="%(?..%{$fg_no_bold[red]%}<%?>%{$reset_color%})"
 fi
 
+# The primary prompt string, printed before a command is read.
 PS1="${system_emoji}${emoji_spacing} $(ax_logname_prompt_yn)$(ax_hostname_prompt_yn)%B%2~%b"'$(ax_vcs_prompt)'"$(ax_prompt)"
 
 # Default execution trace prompt.
-- 
2.39.2