Skip to content

Commit

Permalink
Updated with architectural notes.
Browse files Browse the repository at this point in the history
  • Loading branch information
kurtraschke committed Sep 9, 2009
1 parent 3c331d7 commit 88766e0
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions TODO
Expand Up @@ -9,3 +9,17 @@
* Improve documentation, both of the code and Textile syntax. * Improve documentation, both of the code and Textile syntax.
The previous version of pytextile had excellent inline documentation; The previous version of pytextile had excellent inline documentation;
similarly, docstrings such as "What does this do?" should be improved. similarly, docstrings such as "What does this do?" should be improved.

* 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().

* If we want to re-implement sanitization or validation, it should probably be
done with html5lib.

0 comments on commit 88766e0

Please sign in to comment.