Skip to content

Commit a44a7f3

Browse files
committed
Merge branch 'release/0.2.19'
2 parents b52a586 + 118fb5b commit a44a7f3

7 files changed

Lines changed: 247 additions & 224 deletions

File tree

.codoopts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
--readme API.md
1+
--name 'Node-Neo4j API Documentation'
22
--title 'Node-Neo4j API Documentation'
3+
--readme API.md
34
./lib

API.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ link for general info, installation instructions, and more.
77

88
This API documentation is fairly self-explanatory, but here are some notes:
99

10+
- When you `require('neo4j')`, all you get back is a reference to the
11+
**[`GraphDatabase` class](classes/GraphDatabase.html)**, so start there.
12+
1013
- The `_` parameter in all method signatures signifies an async callback.
1114
All async callbacks are of the standard Node form `(err, result)`.
1215

@@ -15,10 +18,8 @@ This API documentation is fairly self-explanatory, but here are some notes:
1518
as standard "return" values.
1619

1720
- But, all async methods actually do have true return values -- they all
18-
return *[futures][]*. Futures are functions that take the same async
19-
callback as the method, so you can choose to pass a callback (to handle the
20-
async error or result) at a point later than when you call the method.
21-
You don't need to worry about these at all if you don't want to.
21+
return Streamline *[futures][]*. You don't need to worry about these at all
22+
if you don't want to.
2223

2324
[futures]: https://github.com/Sage/streamlinejs#futures
2425

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## Version 0.2.19 — October 1, 2012
2+
3+
- No code changes, just improvements to the
4+
**[API documentation][api-docs]**.
5+
16
## Version 0.2.18 — September 30, 2012
27

38
- **[API documentation][api-docs]** has finally been added! Many thanks to

0 commit comments

Comments
 (0)