explain code with comment

uppercase Logya
yaph · Aug 7, 2016 · e11c7a5 · e11c7a5
1 parent 4a68afb
commit e11c7a5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,7 +40,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'logya'
+project = u'Logya'
 copyright = u'2016, Ramiro Gómez'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -186,7 +186,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'logya.tex', u'logya Documentation',
+  ('index', 'logya.tex', u'Logya Documentation',
    u'Ramiro Gómez', 'manual'),
 ]
 
@@ -230,7 +230,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'logya', u'logya Documentation',
+  ('index', 'logya', u'Logya Documentation',
    u'Ramiro Gómez', 'logya', 'One line description of project.',
    'Miscellaneous'),
 ]

diff --git a/logya/path.py b/logya/path.py
@@ -20,7 +20,7 @@ def canonical_filename(name):
     Leading slashes are stripped off.
     """
 
-    # TODO explain this
+    # Paths for generated indexes do not start with a slash.
     if not name.startswith('/'):
         name = '/{}'.format(name)