Skip to content
Browse files

Updated with architectural notes.

  • Loading branch information...
1 parent 3c331d7 commit 88766e055a2ab315eeeb22084f6ab08fa300939c @kurtraschke kurtraschke committed Sep 9, 2009
Showing with 14 additions and 0 deletions.
  1. +14 −0 TODO
@@ -9,3 +9,17 @@
* Improve documentation, both of the code and Textile syntax.
The previous version of pytextile had excellent inline documentation;
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.
Something went wrong with that request. Please try again.