aligned documentation to double-done

Author: iccicci

README.md

@@ -1,4 +1,4 @@
-# node-postgres-orm
+## node-postgres-orm
 
 [![Build Status](https://travis-ci.org/iccicci/node-postgres-orm.png)](https://travis-ci.org/iccicci/node-postgres-orm)
 [![Code Climate](https://codeclimate.com/github/iccicci/node-postgres-orm/badges/gpa.svg)](https://codeclimate.com/github/iccicci/node-postgres-orm)
@@ -18,21 +18,21 @@ Applying changes to database after releasing a new version of application is oft
 during development stage, often results in a complex sequence of backward and forward steps through migrations; this process is complicated more and more especially when
 working in team with concurrent changes to the models (or database schema). This package tries to solve these problems all in once.
 
-# Table of Contents
+## Table of Contents
 
 * [node-postgres-orm](#node-postgres-orm)
 * [Installation](#installation)
 * [Error reporting](#error-reporting])
   * [Usage error reporting](#usage-error-reporting)
   * [Data error reporting](#data-error-reporting)
 * [Quick Start Example](#quick-start-example)
+* [Requirements](#requirements)
+* [Testing](#testing)
 * [Bugs](#bugs)
 * [Documentation](#documentation)
 * [Changelog](#changelog)
-* [Requirements](#requirements)
-* [Testing](#testing)
 
-# Installation
+## Installation
 
 With [npm](https://www.npmjs.com/package/pgo):
 ```sh
@@ -41,15 +41,15 @@ $ npm install --save pgo
 
 Back to: [top](#) - [ToC](#table-of-contents)
 
-# Error reporting
+## Error reporting
 
-## Usage error reporting
+### Usage error reporting
 
 __Pgo__ _functions_ and _methods_ have syncornous usage error reporting. Exceptions are thrown in case of wrong
 parameters number or types. Anyway it should not be required to call __pgo__ _functions_ in a __try catch__ block,
 this kind of errors should be generated only at development time.
 
-## Data error reporting
+### Data error reporting
 
 All __pgo__ _methods_ and _function_ accessing data have asyncronous error reporting to check data integrity or
 consistency errors, database connection errors, etc...
@@ -58,7 +58,7 @@ __Pgo__ implements the [double done](https://www.npmjs.com/package/double-done)
 
 Back to: [top](#) - [ToC](#table-of-contents)
 
-# Quick Start Example
+## Quick Start Example
 
 ```javascript
 var Pgo = require('pgo');
@@ -88,7 +88,7 @@ db.connect(console.log, function() {
 });
 ```
 
-## Output example
+### Output example
 
 On db creation:
 
@@ -132,12 +132,12 @@ Pgo: ALTER TABLE bars ALTER COLUMN baz TYPE varchar(20)
 Pgo: ALTER TABLE bars ALTER COLUMN baz DROP NOT NULL
 ```
 
-# Requirements
+## Requirements
 
 * __Node.js 5.0__ or higher.
 * __PostgreSQL 9.3__ or higher.
 
-# Testing
+## Testing
 
 To test this package is strongly required the acces to a __PosgtreSQL__ database. The connection string should
 be specified in the _evironment variable_ __PGO_TEST_DB__.
@@ -153,13 +153,13 @@ __PostgreSQL__.
 
 Back to: [top](#) - [ToC](#table-of-contents)
 
-# Bugs
+## Bugs
 
 Do not hesitate to report any bug or inconsistency [@github](https://github.com/iccicci/node-postgres-orm/issues).
 
-## Known bugs
+### Known bugs
 
-### Inheritance in clone
+#### Inheritance in clone
 
 Model inheritance is not respected in __models__ of _cloned_ __Pgo__.
 
@@ -184,7 +184,7 @@ db1.connect(console.log, function() {
 
 Back to: [top](#) - [ToC](#table-of-contents)
 
-# Documentation
+## Documentation
 
 Documentation can be found at
 [documentation index](https://github.com/iccicci/node-postgres-orm/blob/master/doc/Home.md).
@@ -194,7 +194,7 @@ or not working as described.
 
 Back to: [top](#) - [ToC](#table-of-contents)
 
-# Changelog
+## Changelog
 
 * 2017-??-?? - v0.2.0
   * Added [double done](https://www.npmjs.com/package/double-done)

doc/Pgo.md

@@ -191,7 +191,7 @@ The object which defines _model_ or _table_ options.
 
 ## load
 ```javascript
-Pgo.load.<model_name>(where [, order], callback)
+Pgo.load.<model_name>(where [, order], done [, doneOk])
 ```
 
 Reads data from database with a standard __SQL query__ and makes it a set of __pgo.record__(s).
@@ -204,7 +204,8 @@ Please refer to [Accessing data](AccessingData.md) for details.
 The _Array_ which defines the __ORDER BY__ field list. It can be simply omitted.
 Please refer to [Accessing data](AccessingData.md) for details.
 
-#### callback(err, res)
+#### done(err [, res])
+#### doneOk(res)
 The _callback_ function __pgo__ will call after data is loaded.
 
 * __err__: the error description, __null__ if data loaded without errors.
@@ -217,6 +218,10 @@ new Pgo.models.<model_name>([tx])
 
 Creates a __new pgo.record__ to be saved later in database.
 
+#### tx
+
+The transaction within the __Pgo.record__ must be saved (_inserted_).
+
 #### return value
 The newly created __pgo__ [Record](Record.md).
 [comment]: <> (doc end)

doc/Record.md

@@ -56,6 +56,37 @@ The _callback_ function __pgo__ will call after __record__ is saved.
 
 * __err__: the error description, __null__ if record was saved without errors.
 
+# Accessors
+
+## <FKEY_name>Load
+```javascript
+Record.<FKEY_name>Load(done [, doneOk])
+```
+
+Loads the __pgo.record__ referenced by the __foreing key__.
+
+#### done(err [,res])
+#### doneOk(res)
+The _callback_ function __pgo__ will call after __record__ is saved.
+
+* __err__: the error description, __null__ if data loaded without errors.
+* __res__: the __pgo.record__ referenced by one against te _accessor_ was called.
+
+## <FKEY_name>Lock
+```javascript
+Record.<FKEY_name>Lock(done [, doneOk])
+```
+
+If the __pgo.record__ was loaded or created within a __transaction__, loads and locks the __pgo.record__ referenced by
+the __foreing key__.
+
+#### done(err [,res])
+#### doneOk(res)
+The _callback_ function __pgo__ will call after __record__ is saved.
+
+* __err__: the error description, __null__ if data loaded without errors.
+* __res__: the __pgo.record__ referenced by one against te _accessor_ was called.
+
 # Hooks
 
 ## postDelete

doc/Transaction.md

@@ -27,24 +27,26 @@ actions on _database_ in the current _transaction_.
 
 ## commit
 ```javascript
-Pgo.commit(callback)
+Transaction.commit(done [, doneOk])
 ```
 
 Issues the __COMMIT__ command and closes the __pg__ client.
 
-#### callback(err)
+#### done(err)
+#### doneOk()
 The _callback_ function __pgo__ will call after the __COMMIT__ command is issued to database.
 
 * __err__: the error description, __null__ if no errors occurred.
 
 ## client
 ```javascript
-Pgo.rollback(callback)
+Transaction.rollback(done [, doneOk])
 ```
 
 Issues the __ROLLBACK__ command and closes the __pg__ client.
 
-#### callback(err)
+#### done(err)
+#### doneOk()
 The _callback_ function __pgo__ will call after the __ROLLBACK__ command is issued to database.
 
 * __err__: the error description, __null__ if no errors occurred.
@@ -54,26 +56,14 @@ The _callback_ function __pgo__ will call after the __ROLLBACK__ command is issu
 
 ## load
 ```javascript
-Pgo.load.<model_name>(where, order, callback)
-```
-
-or
-
-```javascript
-Pgo.load.<model_name>(where, callback)
+Transaction.load.<model_name>(where, [order,] done [, doneOk])
 ```
 
 It works as __Pgo.load__ but it works within _transaction_.
 
 ## lock
 ```javascript
-Pgo.lock.<model_name>(where, order, callback)
-```
-
-or
-
-```javascript
-Pgo.lock.<model_name>(where, callback)
+Transaction.lock.<model_name>(where, [order,] done [, doneOk])
 ```
 
 It works as __Transaction.load__ but it __locks__ the records untill the _transaction_ is