Merge pull request #2174 from dmcdougall/comment_tweak

dmcdougall · dmcdougall · commit 9c03be08fd78 · 2013-06-29T08:09:12.000-07:00
Just a minor comment tweak
diff --git a/doc/sphinxext/gen_rst.py b/doc/sphinxext/gen_rst.py
@@ -121,7 +121,9 @@ def generate_example_rst(app):
             rstfile = '%s.rst'%basename
             outrstfile = os.path.join(rstdir, rstfile)
 
-            # XXX make into title
+            # XXX: We might consider putting extra metadata in the example
+            # files to include a title. If so, this line is where we would add
+            # this information.
             fhsubdirIndex.write('    %s <%s>\n'%(os.path.basename(basename),rstfile))
 
             do_plot = (subdir in example_subdirs
