From d3a36b992b5fec2569796a944d25844339393b4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pawe=C5=82=20P=C5=82azie=C5=84ski?= <nivertius@gmail.com>
Date: Thu, 17 Dec 2015 17:31:40 +0100
Subject: [PATCH] some comments

---
 .zshrc | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/.zshrc b/.zshrc
index 2196ce3..f6667ce 100644
--- a/.zshrc
+++ b/.zshrc
@@ -22,8 +22,9 @@ GEAR="\u2699"
 BULLET="\u2022"
 CROSSING="\u292c"
 
-#--- Helpers
+#---------------------------------- Helpers -----------------------------------
 
+# Search file up in directory tree
 find_up () {
   path=$(pwd)
   while [[ "$path" != "" ]]; do
@@ -37,6 +38,9 @@ find_up () {
 
 #---------------------------------- Tab completion ----------------------------
 
+autoload -Uz compinit
+compinit
+
 # Force a reload of completion system if nothing matched; this fixes installing
 # a program and then trying to tab-complete its name
 _force_rehash() {
@@ -74,9 +78,6 @@ zstyle :compinstall filename "$HOME/.zshrc"
 # Always do mid-word tab completion
 setopt complete_in_word
 
-autoload -Uz compinit
-compinit
-
 #---------------------------------- History -----------------------------------
 
 setopt extended_history
@@ -381,9 +382,11 @@ bindkey "\e[B" down-line-or-local-history
 
 #---------------------------------- Aliases ----------------------------------
 
+# Use interactive sudo instead of su
 alias su="sudo -u root -i"
 
 #---------------------------------- Maven ------------------------------------
+# Coloring maven output
 # based on https://gist.github.com/katta/1027800
 
 mvn-color()
@@ -406,7 +409,7 @@ mvn-color()
 }
 alias mvn='mvn-color'
 
-# Read project into current directory
+# Read project information from current directory - needed for prompt
 
 maven_read_project() {
 	local location parts
@@ -453,6 +456,8 @@ store_last_return_value() {
 	LAST_RETURN_VALUE="$?"
 }
 
+# Store last return value into separate variable
+# This must be exactly first precmd function, because other precmd might modify $?
 precmd_functions=(store_last_return_value $precmd_functions)
 
 #---------------------------------- Machine specific --------------------------