review-1.0.txt 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. Fixed
  2. -----
  3. [x] Shouldn't the ezcDocumentRstXhtmlVisitorTests tests just be
  4. ezcDocumentXhtmlVisitorTests ?
  5. No, as they are special test for the RstXhtml visitor, which explicitely
  6. visit the RST AST. We may have other XHtml visitors later, like for
  7. DocBook
  8. [x] Low code coverage in some parts.
  9. The parts which are actually implemented do have a >90% coverage. The
  10. other stuff is just misses test and implementation.
  11. The ast node base class also have low coverage, while the uncovered
  12. methods are jsut debugging helper methods, which are viable for parser
  13. debugging. But we may want to remove them in the release...
  14. [x] WHy is the RstXhtmlVisitor not simple a docbook visitor to generate XHTML?
  15. This is what we originally discussed as conversion shortcuts. A Docbook
  16. XHtml visitor will also be added. The direct conversion has access to more
  17. semantic information, then after the docbook conversion.
  18. [x] Why are the option class names including "Base" as in
  19. ezcDocumentParserBaseOptions and ezcDocumentConverterBaseOptions,
  20. ezcDocumentXmlBaseOptions.
  21. Fixed, removed "Base" from option class names.
  22. [x] Some of the class descriptions in document/rst/nodes/* are incorrect
  23. (Example is ezcDocumentRstSubstitutionNode).
  24. Fixed.
  25. [x] ezcDocumentRstToken doesn't have the constants documented - also run
  26. the doc analysis tool because there's some other stuff as well.
  27. Fixed.
  28. [x] Docblocks are broken for some files (eg. src/document/rst/nodes): there
  29. are duplicated @copyright and @license, and the @package is not Document.
  30. Fixed.
  31. [x] Strings should enclose variables in {}: "Could not find visitor for '{$class}'"
  32. Fixed
  33. [x] The tutorial should mention on how to extend the RST directives thingy.
  34. Fixed
  35. [x] A description of how the RST parser actually works should be added.
  36. Fixed
  37. [x] Why is ezcDocumentManager final?
  38. Because it is / will be a class only providing static (conversion)
  39. methods with a static registry of known documents. Once used in your code
  40. it makes nearly no sense to extend. But we can remove the final keyword to
  41. make it possible for users to write (and only use) their own manager on
  42. this base.
  43. Removed final keyword
  44. Open
  45. ----
  46. [ ] There are some @TODOs in the code.
  47. The remaining TODOs will be resolved during further development.