docs

vitaly-t · Apr 4, 2021 · 27c44b9 · 27c44b9
1 parent cfaf90e
commit 27c44b9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -61,7 +61,7 @@ only its tiny part.
 
 I do free support here and on [StackOverflow](https://stackoverflow.com/questions/tagged/pg-promise).
 
-And if you want to help this project, I can accept Bitcoin - `1yki7MXMkuDw8qqe5icVdh1GJZSQSzKZp`.
+And if you want to help this project, I can accept Bitcoin: `1yki7MXMkuDw8qqe5icVdh1GJZSQSzKZp`
 
 # Documentation
 

diff --git a/lib/database.js b/lib/database.js
@@ -147,7 +147,7 @@ function Database(cn, dc, config) {
      * in the end of the chain by calling `done()` on the connection object.
      *
      * Method `done` takes one optional parameter - boolean `kill` flag, to signal the connection pool that you want it to kill
-     * the physical connection. This flag is ignored for direct connections, as they always auto-close when released.
+     * the physical connection. This flag is ignored for direct connections, as they always close when released.
      *
      * It should not be used just for chaining queries on the same connection, methods {@link Database#task task} and
      * {@link Database#tx tx} (for transactions) are to be used for that. This method is primarily for special cases, like
@@ -167,7 +167,7 @@ function Database(cn, dc, config) {
      * By default, all connections are acquired from the connection pool. But if you set this option, the library will instead
      * create a new {@link external:Client Client} object directly (separately from the pool), and then call its `connect` method.
      *
-     * Note that specifically for direct connections, method `done` returns a {external:Promise}, because those connections
+     * Note that specifically for direct connections, method `done` returns a {@link external:Promise Promise}, because those connections
      * are closed physically, which may take time.
      *
      * **WARNING:**
@@ -202,7 +202,8 @@ function Database(cn, dc, config) {
      * A promise object that represents the connection result:
      *  - resolves with the complete {@link Database} protocol, extended with:
      *    - property `client` of type {@link external:Client Client} that represents the open connection
-     *    - method `done` that must be called in the end, in order to release the connection
+     *    - method `done` that must be called in the end, in order to release the connection (returns a {@link external:Promise Promise}
+     *      in case of direct connections)
      *    - methods `batch`, `page` and `sequence`, same as inside a {@link Task}
      *  - rejects with a connection-related error when it fails to connect.
      *