Add and streamline comments for prompt variables

[ax-zsh.git] / themes / ax.axzshtheme

diff --git a/themes/ax.axzshtheme b/themes/ax.axzshtheme
index df8b0565f1349b1dff7ef897806287ae901c8b15..b04dc4add0abe7b916e0a4ce5c5b57e3f0ae6a88 100644 (file)
--- 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