diff --git a/docs/literate.txt b/docs/literate.txt index 148ba3c..340f7e5 100644 --- a/docs/literate.txt +++ b/docs/literate.txt @@ -82,14 +82,20 @@ else (or just unset entirely). You can also use a quoted literal block, although you'll end up with the quoting character inside the result. -To avoid a dependency on an entire reST parser, we place a small -constraint on the specific syntax of the directive line. The code -directives must start on their own line and match the following regular -expression, with whitespace appearing at any point in the line: +To avoid a dependency on an entire reST parser, we actually identify +things that are not proper reST when looking for the ..code:: marker. +The code directives must start on their own line and match the following +string, with whitespace appearing at any point in the line: ..code::ubik The code must start on a new line after the directive, and all lines are -taken until a line with no indentation is found again. This is slightly -less flexible than the reST spec usually allows you to be, but it -simplifies the implementation of the weave operation significantly. +taken until a line with no indentation is found again. This is more +permissive than the reST spec, but it simplifies the implementation of +the weave operation significantly. The following markers are all valid: + + .. code :: ubik + . . c o d e : : u b i k + . .code: :ubik + ..code::ubi k +