summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrsiddharth <s@ricketyspace.net>2017-02-19 04:25:32 +0000
committerrsiddharth <s@ricketyspace.net>2017-02-19 04:25:32 +0000
commit64c48534e487deb1b5c4cd45df5487f1cf461ab4 (patch)
tree21e18e8aea809102e85b371181aa25217f2c1c26
parent9bfff9b1d10c875baac78c84cce38dce8ba6cf26 (diff)
Update TODO
-rw-r--r--TODO53
1 files changed, 53 insertions, 0 deletions
diff --git a/TODO b/TODO
index 907250d..0fecd36 100644
--- a/TODO
+++ b/TODO
@@ -2,3 +2,56 @@
TODO
====
+
+* Add unit tests for markdown_link_style.logging module.
+
+ A good place to put the unit tests for this module is under
+ ``tests/markdown_link_style/test_logging.py``.
+
+* Add unit test for ``mdl_style.LSBlockLexer``,
+ ``mdl_style.LSInlineLexer`` classes.
+
+ * The unit tests for these classes must go under
+ ``tests/test_mdl_style.py``.
+
+ * The unit tests must simply check contents of ``default_rules``
+ class variable.
+
+* Add unit test for ``mdl_style.LSMarkdown``.
+
+ The unit test must verify that the class variables ``renderer``,
+ ``inline``, ``block`` are instances of ``mdl_style.LSRenderer``,
+ ``mdl_style.InlineLexer`` and ``mdl_style.LSBlockLexer``
+ respectively.
+
+* Add unit tests for ``mdl_style.LSRenderer`` under
+ ``tests.test_mdl_style.TestLSRendererIL`` and
+ ``tests.test_mdl_style.TestLSRendererFN`` to verify that the
+ renderer does not modify block/inline elements other than links and
+ paragraphs.
+
+ Specifically, unit tests must be added to verify that the following
+ block/inline elements are not modified by the
+ ``mdl_style.LSRenderer`` renderer:
+
+ * Block elements:
+
+ * Paragraphs and Line Breaks
+ * Headers
+ * Blockquotes
+ * Lists
+ * Code Blocks
+ * Horizontal Rules
+
+ * Inline elements:
+
+ * Emphasis
+ * Code
+ * Images
+
+ For instance, if the input contains ``## This is an H2``, the
+ ``mdl_style.LSRenderer`` renderer must not change it to ``<h2>This
+ is an H2</h2``; it must leave as is -- ``## This is an H2``.
+
+ For info on the markup of the above elements, see
+ https://daringfireball.net/projects/markdown/syntax