Changeset 3060

Timestamp:

11/26/05 13:19:26 (7 years ago)

Author:

moschny

Message:

• Cleanup of some doc strings.
• Remove unused code.

File:

• trac/trunk/wiki-macros/TracNav.py (modified) (6 diffs)

trac/trunk/wiki-macros/TracNav.py

@@ -108 +108 @@
         OneLinerFormatter.__init__(self, env)
         self.link = None
-        self.myenv = env
 
     def _make_link(self, namespace, target, match, label):
@@ -127 +126 @@
 def get_toc_entry(toc_text, env):
     """
-    Filter the toc_text for toc entries.
+    Parse and format the entries in toc_text.
     """
     for match in LISTRULE.finditer(toc_text):
         indent = len(match.group('indent'))
         label, link = format_toc_entry(match.group('rest'), env)
-        # env.log.debug("link is '%s'" % link)
         yield indent, link, label
 
@@ -138 +136 @@
 def get_toc_entry_and_indent(gen):
     """
-    Filter for get_toc_entry().  Returns link and label of the current
-    toc entry and the indentation level of the next entry or -1 if
-    there are no more entries. The first call to next() returns the
-    indentation of the first entry.
+    Filter for get_toc_entry().  The first call to next() returns the
+    indentation level of the next entry (or -1 if there are no more
+    entries) and the second call returns the entry itself.
     """
     while True:
@@ -161 +158 @@
         else:                   # broken indentation structure
             toclist.append((None, None, sublist))
-    while 1:
+    while True:
         if next_indent == level:
             (link, label), next_indent = gen.next(), gen.next()
@@ -175 +172 @@
 
 def parse_toc(toc_text, env):
+    """
+    Recursively construct the toc tree using _parse_toc().
+    """
     gen = get_toc_entry_and_indent(get_toc_entry(toc_text, env))
     toclist, _ = _parse_toc(gen, gen.next())
@@ -181 +181 @@
 
 def execute(hdf, args, env):
+    """
+    Main routine of the wiki macro.
+    """
     preview = hdf.getValue('args.preview', "")
     curpage = hdf.getValue('wiki.page_name', "")