Skip to content

Commit

Permalink
Update TODO to reflect reality.
Browse files Browse the repository at this point in the history
  • Loading branch information
kurtraschke committed Jul 15, 2010
1 parent ab24f92 commit 7fe6382
Showing 1 changed file with 3 additions and 22 deletions.
25 changes: 3 additions & 22 deletions TODO
Original file line number Diff line number Diff line change
@@ -1,24 +1,5 @@
* Improve test coverage
nose is configured to produce coverage statistics.

* Improve documentation, both of the code and Textile syntax.
Not all functions have docstrings or adequate docstrings.
Because the Textile syntax implemented by pytextile has deviated from
the syntax implemented by the PHP implementation of Textile,
pytextile-specific documentation needs to be produced for end-users.


* Address outstanding architectural issues:
The Textile class has a large number of public methods which are, in fact,
not intended to be called by the public.
Also, some parameters are set in __init__(), while others are set in
textile().
Because various instance variables get set while text is being processed,
a Textile object cannot be reused--that is, it is not possible to set up
a Textile object with the desired parameters, and then use it repeatedly
to process multiple strings, because parameters such as the shelf do not
get reset between calls to textile().

* Re-implement HTML sanitization:
HTML sanitization was stripped out due to sgmllib's deprecation; if
re-implemented, html5lib should be used.
Because the Textile syntax implemented by PyTextile has deviated
from the syntax implemented by other implementations of Textile,
PyTextile-specific documentation needs to be produced for end-users.

0 comments on commit 7fe6382

Please sign in to comment.