Add helpful commentary to bash shell-completion script

medic · Jun 5, 2017 · 019a21f · 019a21f
1 parent ff5e53f
commit 019a21f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/cli/shell-completion.bash b/src/cli/shell-completion.bash
@@ -2,13 +2,16 @@
 
 completions() {
 	local cur
+
+	# Magic to treat colons in completion strings as normal characters (part 1)
 	_get_comp_words_by_ref -n : cur
 
 	options="$(shell-completion-for-medic-conf $COMP_CWORD $cur)"
 
 	# Tell complete what stuff to show.
 	COMPREPLY=($(compgen -o dirnames -W "$options" -- "$cur"))
 
+	# Magic to treat colons in completion strings as normal characters (part 2)
 	__ltrim_colon_completions "$cur"
 }