barak/cayley
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #204 from barakmich/minor_fixes

Browse source 
Minor doc fixes
This commit is contained in:
Barak Michener 2015-02-05 20:09:15 -05:00
commit 9a2dcab51b
2 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/GremlinAPI.md
View file

@ -45,7 +45,7 @@ Adds data programatically to the JSON result list. Can be any JSON type.
## Path objects ## Path objects
Both `.Morphism()` and `.Vertex()` create path objects, which provide the following traversal methods. Both `.Morphism()` and `.Vertex()` create path objects, which provide the following traversal methods. Note that `.Vertex()` returns a query object, which is a subclass of path object.
For these examples, suppose we have the following graph: For these examples, suppose we have the following graph:
``` ```
@ -362,10 +362,10 @@ Returns: Array
Executes a query and returns the results at the end of the query path. Executes a query and returns the results at the end of the query path.
Example: Example:
``javascript ```javascript
// fooNames contains an Array of names for foo. // fooNames contains an Array of names for foo.
var fooNames = g.V("foo").Out("name").ToArray() var fooNames = g.V("foo").Out("name").ToArray()
`` ```
####**`query.ToValue()`** ####**`query.ToValue()`**
@ -383,12 +383,12 @@ Returns: Array of string-to-string objects
As `.ToArray` above, but instead of a list of top-level strings, returns an Array of tag-to-string dictionaries, much as `.All` would, except inside the Javascript environment. As `.ToArray` above, but instead of a list of top-level strings, returns an Array of tag-to-string dictionaries, much as `.All` would, except inside the Javascript environment.
Example: Example:
``javascript ```javascript
// fooNames contains an Array of names for foo. // fooNames contains an Array of names for foo.
var fooTags = g.V("foo").Tag("foo_value").Out("name").ToArray() var fooTags = g.V("foo").Tag("foo_value").Out("name").ToArray()
// fooValue should be the string "foo" // fooValue should be the string "foo"
var fooValue = fooTags[0]["foo_value"] var fooValue = fooTags[0]["foo_value"]
`` ```
####**`query.TagValue()`** ####**`query.TagValue()`**

2
docs/Overview.md
View file

@ -12,7 +12,7 @@ If you prefer to build from source, see the documentation on the wiki at [How to
Now that Cayley is built, let's create our database. `init` is the subcommand to set up a database and the right indices. Now that Cayley is built, let's create our database. `init` is the subcommand to set up a database and the right indices.
You can set up a full [configuration file](/docs/Configuration) if you'd prefer, but it will also work from the command line. You can set up a full [configuration file](/docs/Configuration.md) if you'd prefer, but it will also work from the command line.
Examples for each backend: Examples for each backend: