add better comments to the part-handler example

1 files changed, 12 insertions, 1 deletions

diff --git a/doc/examples/part-handler.txt b/doc/examples/part-handler.txt
index 1fe37f3a..a6e66415 100644
--- a/doc/examples/part-handler.txt
+++ b/doc/examples/part-handler.txt
@@ -2,10 +2,21 @@
 # vi: syntax=python ts=4
 
 def list_types():
+    # return a list of mime-types that are handled by this module
     return(["text/plain", "text/go-cubs-go"])
 
 def handle_part(data,ctype,filename,payload):
-    if ctype == "__end__" or ctype == "__begin__": return
+    # data: the cloudinit object
+    # ctype: '__begin__', '__end__', or the specific mime-type of the part
+    # filename: the filename for the part, or dynamically generated part if
+    #           no filename is given attribute is present
+    # payload: the content of the part (empty for begin or end)
+    if ctype == "__begin__":
+       print "my handler is beginning"
+       return
+    if ctype == "__end__":
+       print "my handler is ending"
+       return
 
     print "==== received ctype=%s filename=%s ====" % (ctype,filename)
     print payload