Merge pull request #41 from nachtschattengewaechs/master

Add some additional explanations to example.cfg

example.cfg

@@ -14,22 +14,28 @@ status_path = ~/.vdirsyncer/status/
 
 # CONTACTS
 [pair bob_contacts]
-# Similar to accounts in OfflineIMAP.
+# A `[pair <name>]` block defines two storages `a` and `b` that should be
+# synchronized. The definition of these storages follows in `[storage <name>]`
+# blocks. This is similar to accounts in OfflineIMAP.
 a = bob_contacts_local
 b = bob_contacts_remote
 
-# collections are addressbooks, calendars etc to be synced. The comma-separated
-# values in this parameter are representing subdirectories, are added as URL
-# segment or similar.
+# If you want to synchronize several addressbooks, calendars etc that share
+# the same storage location and differ only in a suffix to this location
+# (i.e., a subdirectory) you can use collections. The comma-separated values
+# in this parameter represent these subdirectories and are added as URL
+# segments or similar.
 
-# In this example, it means that
+# Together with the definition of the following two `[storage]` blocks below
+# in this example it means that
 #   - https://owncloud.example.com/remote.php/carddav/addressbooks/bob/default/
 #     will get synced with ~/.contacts/default/
 #   - https://owncloud.example.com/remote.php/carddav/addressbooks/bob/work/
 #     will get synced with ~/.contacts/work/
 
-# Omitting this parameter implies that the given path and URL are already
-# pointing to a collection each.
+# Omitting this parameter implies that the given path and URL in the
+# corresponding `[storage <name>]` blocks are already pointing to a
+# collection each.
 collections = default,work
 
 # conflict_resolution = None  # abort when collisions occur (default)