summaryrefslogtreecommitdiffstats
path: root/TODO
blob: 931c0050a1f6b14781eda44814e4e606206d6cc2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
-*- mode: rst; coding: utf-8; -*-

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:

  * Inline elements:

    * Emphasis
    * Code

  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