Commits

Bob Ippolito  committed a0d4f36

Update the documentation TODO item to reflect some of the things I want
to happen *after* PyObjC 1.2 :)

  • Participants
  • Parent commits 53880c6

Comments (0)

Files changed (2)

File pyobjc/Doc/TODO.html

 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>
-Todo list</title>
+TODO list</title>
 <title>
 Contents</title>
 </head>
 <body>
-<h2>Todo list</h2>
+<h2>TODO list</h2>
 <h2>Contents</h2>
 <ul>
 <li><a href="#introduction" id="id1" name="id1">Introduction</a></li>
 <p>This document contains an (incomplete) list of work items.</p>
 <h2><a href="#id2" name="important-items">Important items</a></h2>
 <h3><a href="#id3" name="better-documentation">Better documentation</a></h3>
-<p>There should be more developer and and end-user documentation.</p>
+<ul>
+<li>There should be more developer and and end-user documentation.</li>
+<li>The tutorials should have screenshots for the website.</li>
+<li>There should be a document containing references to &quot;third party&quot; tutorials,
+articles, and information about PyObjC.</li>
+<li>The documentation should be updated to take advantage of reStructuredText
+features.  Currently, documentation doesn't refer to itself consistently
+(usually without hyperlink), and most documents are missing metadata.</li>
+<li>build_html should include a step that performs syntax highlighting for
+Python and Objective-C code snippets.</li>
+</ul>
 <h3><a href="#id4" name="test-suite">Test suite</a></h3>
 <p>The test suite needs to be enhanced.</p>
 <ul>

File pyobjc/Doc/TODO.txt

 =========
-Todo list
+TODO list
 =========
 
 .. contents::
 Better documentation
 ....................
 
-There should be more developer and and end-user documentation.
+* There should be more developer and and end-user documentation.
+
+* The tutorials should have screenshots for the website.
+
+* There should be a document containing references to "third party" tutorials,
+  articles, and information about PyObjC.
+
+* The documentation should be updated to take advantage of reStructuredText
+  features.  Currently, documentation doesn't refer to itself consistently
+  (usually without hyperlink), and most documents are missing metadata.
+
+* build_html should include a step that performs syntax highlighting for
+  Python and Objective-C code snippets.
 
 Test suite
 ..........