Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixed broken examples in the documentation

This commit is contained in:
Thomas Schmidts 2015-04-12 13:47:26 +02:00
parent 448e496df6
commit d7dc9ea169
2 changed files with 45 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/Books/codeBlockReader.py
View File

@ -121,18 +121,18 @@ def example_content(filepath, fh, tag):
fh.write("<div id=\"%s\">\n" % longTag)
fh.write("<pre>\n")
fh.write("```\n")
# fh.write("```\n")
fh.write("%s" % long)
fh.write("```\n")
# fh.write("```\n")
fh.write("</pre>\n")
fh.write("</div>\n")
if shortable:
fh.write("<div id=\"%s\" onclick=\"%s\">\n" % (shortTag, shortToggle))
fh.write("<pre>\n")
fh.write("```\n")
# fh.write("```\n")
fh.write("%s" % short)
fh.write("```\n")
# fh.write("```\n")
if arangosh:
fh.write("</pre><div class=\"example_show_button\">show execution results</div>\n")

59
arangod/V8Server/v8-query.cpp
View File

@ -1898,11 +1898,19 @@ static void JS_ChecksumCollection (const v8::FunctionCallbackInfo<v8::Value>& ar
///
/// @EXAMPLES
///
/// @EXAMPLE_ARANGOSH_OUTPUT{edgeCollectionEdges}
/// ~ db._create("example");
/// db.relation.edges("vertex/1593622");
/// ~ db._drop("example");
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// ```bash
/// arango> db.relation.edges("vertex/1593622");
/// [
/// {
/// "_id" : "relation/3100950",
/// "_key" : "3100950",
/// "_rev" : "3100950",
/// "_from" : "vertex/1528086",
/// "_to" : "vertex/1593622",
/// "label" : "knows"
/// }
/// ]
/// ```
///
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////
@ -1924,13 +1932,21 @@ static void JS_EdgesQuery (const v8::FunctionCallbackInfo<v8::Value>& args) {
/// *vertices*, which must a list of documents or document handles.
///
/// @EXAMPLES
///
/// @EXAMPLE_ARANGOSH_OUTPUT{edgeCollectionInEdges}
/// ~ db._create("example");
/// db.relation.inEdges("vertex/1528086");
/// db.relation.inEdges("vertex/1593622");
/// ~ db._drop("example");
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// ```bash
/// arango> db.relation.inEdges("vertex/1528086");
/// [ ]
/// arango> db.relation.inEdges("vertex/1593622");
/// [
/// {
/// "_id" : "inEdges/3100950",
/// "_key" : "3100950",
/// "_rev" : "3100950",
/// "_from" : "vertex/1528086",
/// "_to" : "vertex/1593622",
/// "label" : "knows"
/// }
/// ]
/// ```
///
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////
@ -2361,12 +2377,19 @@ static void JS_NearQuery (const v8::FunctionCallbackInfo<v8::Value>& args) {
///
/// @EXAMPLES
///
/// @EXAMPLE_ARANGOSH_OUTPUT{edgeCollectionOutEdges}
/// ~ db._create("example");
/// db.relation.inEdges("vertex/1528086");
/// db.relation.inEdges("vertex/1593622");
/// ~ db._drop("example");
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// ```bash
/// arango> db.relation.edges("vertex/1593622");
/// [
/// {
/// "_id" : "relation/3100950",
/// "_key" : "3100950",
/// "_rev" : "3100950",
/// "_from" : "vertex/1528086",
/// "_to" : "vertex/1593622",
/// "label" : "knows"
/// }
/// ]
/// ```
///
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////