specify method return type in docs

[isc-rsingh]

In each section of the docs, make clear what the return type is

[bradley-holt]

@rajrsingh Do you mean something like this (adding console.log(shoppingList) and the comment after that)?

const { ShoppingListFactory } = require("ibm-shopping-list-model");

const shoppingListFactory = new ShoppingListFactory();

let shoppingList = shoppingListFactory.newShoppingList({
  title: "Groceries"
});

console.log(shoppingList._id);                      // list:…
console.log(shoppingList._rev);                     // undefined
console.log(shoppingList.title);                    // Groceries
console.log(shoppingList);
/*
Record {
    _id: "list:cj7m3o8f8000081f40g5167yj",
    _rev: undefined,
    _deleted: false,
    type: "list",
    version: 1,
    title: "Groceries",
    checked: false,
    place: undefined,
    createdAt: undefined,
    updatedAt: undefined
}
*/

[isc-rsingh]

@bradley-holt showing an entire example Record object is great. I was thinking simply stating the key function name and that it returns an Immutable Record object under the heading, e.g.

Finding a Count of Checked Shopping List Items by Shopping List from a Database

Use a Shopping List Repository to find a count of checked Shopping List Items by Shopping List from a database:

shoppingListRepository.findItemsCountByList({JSON object/selector})

returns: ImmutableJS List