From 78e109008f18492bd0420171b5b29a6088dd94fd Mon Sep 17 00:00:00 2001
From: Jamie Hardt <jamiehardt@me.com>
Date: Wed, 9 Oct 2019 10:38:56 -0700
Subject: [PATCH] Some comments

---
 ptulsconv/commands.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/ptulsconv/commands.py b/ptulsconv/commands.py
index 3968e52..53332c1 100644
--- a/ptulsconv/commands.py
+++ b/ptulsconv/commands.py
@@ -7,6 +7,10 @@ def fmp_dump(data, input_file_name, output):
     from xml.etree.ElementTree import TreeBuilder, ElementTree, tostring
     doc = TreeBuilder(element_factory=None)
 
+    # field_map maps tags in the text export to fields in FMPXMLRESULT
+    #  - tuple field 0 is a list of tags, the first tag with contents will be used as source
+    #  - tuple field 1 is the field in FMPXMLRESULT
+    #  - tuple field 2 the constructor/type of the field
     field_map = ((['Title', 'PT.Session.Name'], 'Title', str),
                  (['Supv'], 'Supervisor', str),
                  (['Client'], 'Client', str),