Re: Issue 3491: Add \displayMarkup command. (issue 12732043)

[dak]

https://codereview.appspot.com/12732043/diff/7001/Documentation/extending/programming-interface.itely
File Documentation/extending/programming-interface.itely (right):

https://codereview.appspot.com/12732043/diff/7001/Documentation/extending/programming-interface.itely#newcode650
Documentation/extending/programming-interface.itely:650: To prevent the
markup from printing on the page, use
On 2013/08/15 10:14:03, Ian Hulin (gmail) wrote:
> "By default @code{\displayMarkup} will print to the console and the
output
> document.  To avoid affecting the output file, use "


I find that even worse.  It's more like

"By default, @code{\displayMarkup} does not only display the markup but
also returns it for use in the document.  This allows you to insert
@code{\displayMarkup} before a markup expression in the document without
changing the resulting document.

If you only want the markup to be displayed but not used in the
document, use @code{\void \displayMarkup} instead."

Personally, I find this does not really meet the "to see how this works"
criterion since the markup expression does _not_ contain a call to the
markup macro at all.  Instead, it is a nested list.

Also, the only thing that makes this "\displayMarkup" rather than
"\displayScheme" is the restriction of the argument type to "markup?".
Perhaps it would make sense to call the whole function \displayScheme
instead and allow arguments of type scheme? here?

https://codereview.appspot.com/12732043/