docs

vitaly-t · Nov 10, 2019 · d922161 · d922161
1 parent 508970e
commit d922161
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/lib/database.js b/lib/database.js
@@ -466,7 +466,7 @@ function Database(cn, dc, config) {
         /**
          * @method Database#none
          * @description
-         * Executes a query that expects no data to be returned. If the query returns any kind of data,
+         * Executes a query that expects no data to be returned. If the query returns any data,
          * the method rejects.
          *
          * When receiving a multi-query result, only the last result is processed, ignoring the rest.
@@ -506,7 +506,7 @@ function Database(cn, dc, config) {
         /**
          * @method Database#one
          * @description
-         * Executes a query that expects exactly one row of data. When 0 or more than 1 rows are returned,
+         * Executes a query that expects exactly 1 row to be returned. When 0 or more than 1 rows are returned,
          * the method rejects.
          *
          * When receiving a multi-query result, only the last result is processed, ignoring the rest.
@@ -580,7 +580,7 @@ function Database(cn, dc, config) {
         /**
          * @method Database#many
          * @description
-         * Executes a query that expects one or more rows. When the query returns no rows, the method rejects.
+         * Executes a query that expects one or more rows to be returned. When the query returns no rows, the method rejects.
          *
          * When receiving a multi-query result, only the last result is processed, ignoring the rest.
          *
@@ -619,8 +619,8 @@ function Database(cn, dc, config) {
         /**
          * @method Database#oneOrNone
          * @description
-         * Executes a query that expects 0 or 1 rows, to resolve with the row-object when 1 row is returned,
-         * and with `null` when nothing is returned. When the query returns more than 1 row, the method rejects.
+         * Executes a query that expects 0 or 1 rows to be returned. It resolves with the row-object when 1 row is returned,
+         * or with `null` when nothing is returned. When the query returns more than 1 row, the method rejects.
          *
          * When receiving a multi-query result, only the last result is processed, ignoring the rest.
          *
@@ -685,7 +685,7 @@ function Database(cn, dc, config) {
         /**
          * @method Database#manyOrNone
          * @description
-         * Executes a query that expects any number of rows.
+         * Executes a query that can return any number of rows.
          *
          * When receiving a multi-query result, only the last result is processed, ignoring the rest.
          *
@@ -728,7 +728,7 @@ function Database(cn, dc, config) {
         /**
          * @method Database#any
          * @description
-         * Executes a query that expects any number of rows.
+         * Executes a query that can return any number of rows.
          * This is simply a shorter alias for method {@link Database#manyOrNone manyOrNone}.
          *
          * When receiving a multi-query result, only the last result is processed, ignoring the rest.
@@ -772,7 +772,7 @@ function Database(cn, dc, config) {
         /**
          * @method Database#result
          * @description
-         * Executes a query without any expectation for the return data, to resolve with the
+         * Executes a query without any expectation for the return data, and resolves with the
          * original $[Result] object when successful.
          *
          * When receiving a multi-query result, only the last result is processed, ignoring the rest.
@@ -839,7 +839,7 @@ function Database(cn, dc, config) {
         /**
          * @method Database#multiResult
          * @description
-         * Executes a multi-query string, without any expectation for the return data, to resolve with an array
+         * Executes a multi-query string, without any expectation for the return data, and resolves with an array
          * of the original $[Result] objects when successful.
          *
          * The operation is atomic, i.e. all queries are executed in a single transaction, unless there are explicit
@@ -878,7 +878,7 @@ function Database(cn, dc, config) {
         /**
          * @method Database#multi
          * @description
-         * Executes a multi-query string without any expectation for the return data, to resolve with an array
+         * Executes a multi-query string, without any expectation for the return data, and resolves with an array
          * of arrays of rows when successful.
          *
          * The operation is atomic, i.e. all queries are executed in a single transaction, unless there are explicit
@@ -968,7 +968,7 @@ function Database(cn, dc, config) {
          *
          * @param {string} funcName
          * Name of the function to be executed.
-         * When the name is not same-case, or uses extended symbols, it is double-quoted.
+         * When it is not same-case, or contains extended symbols, it is double-quoted.
          *
          * @param {array|value} [values]
          * Parameters for the function - one value or an array of values.
@@ -992,12 +992,12 @@ function Database(cn, dc, config) {
          * @description
          * Executes a stored procedure as `CALL procName(values)`, and resolves with `null`.
          *
-         * **NOTE:** This method completely changed in v10 of the driver, to use the new `CALL`
+         * **NOTE:** This method changed in v10 of the driver, and now uses the new `CALL`
          * syntax that requires PostgreSQL v11 or later.
          *
          * @param {string} procName
          * Name of the stored procedure to be executed.
-         * When the name is not same-case, or uses extended symbols, it is double-quoted.
+         * When it is not same-case, or contains extended symbols, it is double-quoted.
          *
          * @param {array|value} [values]
          * Parameters for the procedure - one value or an array of values.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pg-promise",
-  "version": "10.0.0",
+  "version": "10.0.1",
   "description": "PostgreSQL interface for Node.js",
   "main": "lib/index.js",
   "typings": "typescript/pg-promise.d.ts",