From c5f7651e6b0111954e7df20efd8a3ece47dcb3be Mon Sep 17 00:00:00 2001 From: goodger Date: Mon, 2 Jan 2017 21:11:35 +0000 Subject: added notes to the "Doctree pruning" section git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@8009 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- docutils/docs/dev/todo.txt | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) (limited to 'docutils/docs/dev/todo.txt') diff --git a/docutils/docs/dev/todo.txt b/docutils/docs/dev/todo.txt index cd60bb8de..209cbea39 100644 --- a/docutils/docs/dev/todo.txt +++ b/docutils/docs/dev/todo.txt @@ -1959,6 +1959,9 @@ any knowledge of the Python-Reader origin of these elements. Doctree pruning --------------- +[DG 2017-01-02: These are not definitive to-dos, just one developer's +opinion. Added 2009-10-13 by Günter Milde, in r6178.] + The number of doctree nodes can be reduced by "normalizing" some related nodes. This makes the document model and the writers somewhat simpler. @@ -1966,15 +1969,31 @@ nodes. This makes the document model and the writers somewhat simpler. a front-end to generic literal blocks. We could immediately (in 0.7) remove the doctest node from the doctree, but leave the syntax in reST. The reST parser could represent doctest blocks as - literal blocks with a class attribute. The syntax could be left in - reST (for a set period of time?). + literal blocks with a class attribute. + + [DG 2017-01-02:] +0. + + The syntax could be left in reST (for a set period of time?). + + [DG 2017-01-02:] The syntax must be left in reST, practically + forever. Removing it would introduce a huge backwards + incompatibility. Any syntax removal must be preceded by a thorough + review and planning, including a deprecation warning process. My + opinion: it's not worth it. * "Normalize" special admonitions (note, hint, warning, ...) during parsing (similar to _`transforms.writer_aux.Admonitions`). There is no need to keep them as distinct elements in the doctree specification. + [DG 2017-01-02:] -1: {body} is much more concise and + expressive than Note</>{body}</>, and the title + translation can be put off until much later in the process. + Keep the special admonition directives in reStructuredText syntax? + [DG 2017-01-02:] We must definitely keep the syntax. Removing it + would introduce a huge backwards incompatibility. + Unimplemented Transforms ======================== -- cgit v1.2.1