From 37a5640fc204ff5fed31e961d4584c5cbb362669 Mon Sep 17 00:00:00 2001 From: Willi Goesgens Date: Mon, 3 Aug 2015 17:34:16 +0200 Subject: [PATCH] document howto make a wrapped expecterror not produce an empty line --- README_maintainers.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README_maintainers.md b/README_maintainers.md index 937304745a..39e3238644 100644 --- a/README_maintainers.md +++ b/README_maintainers.md @@ -378,7 +378,15 @@ Heres how its details work: OUTPUT and RUN Specialities --------------------------- - OUTPUT is intended to create samples that the users can cut'n'paste into their arangosh. Its used for javascript api documentation. - - it is excuted line by line. If a line is intended to fail (aka throw an exception), you have to specify *// xpError(ERROR_ARANGO_DOCUMENT_KEY_UNEXPECTED)* so the exception will be caught; else the example is marked as broken. + - it is excuted line by line. If a line is intended to fail (aka throw an exception), + you have to specify *// xpError(ERROR_ARANGO_DOCUMENT_KEY_UNEXPECTED)* so the exception will be caught; + else the example is marked as broken. + If you need to wrap that line, you may want to make the next line like this to suppress an empty line: + + /// | someLongStatement() + /// ~ // xpError(ERROR_ARANGO_DOCUMENT_KEY_UNEXPECTED) + + - RUN is intended to be pasted into a unix shell with *cURL* to demonstrate how the REST-HTTP-APIs work. The whole chunk of code is executet at once, and is expected **not to throw**. You should use **assert(condition)** to ensure the result is what you've expected. Additional Example syntax