From 546f9cb29f202d7ed3a4099a9e46b77f5d3747bc Mon Sep 17 00:00:00 2001 From: kennsippell Date: Sun, 8 Dec 2024 20:29:29 -0800 Subject: [PATCH] Docs --- src/lib/hierarchy-operations/replace-lineage.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/lib/hierarchy-operations/replace-lineage.js b/src/lib/hierarchy-operations/replace-lineage.js index 7e7cdbec..018730b1 100644 --- a/src/lib/hierarchy-operations/replace-lineage.js +++ b/src/lib/hierarchy-operations/replace-lineage.js @@ -50,9 +50,9 @@ function replaceEntireLineage(replaceInDoc, lineageAttributeName, replaceWith) { module.exports = { /** - * Given a doc, replace the lineage information therein with "replaceWith" + * Given a doc, replace the parent's lineage * - * @param {Object} doc A CouchDB document containing a hierarchy that needs replacing + * @param {Object} doc A CouchDB document containing a parent lineage (eg. parent.parent._id) * @param {Object} params * @param {Object} params.replaceWith The new hierarchy { parent: { _id: 'parent', parent: { _id: 'grandparent' } } * @param {string} params.startingFromId Only the part of the lineage "after" this id will be replaced @@ -63,9 +63,9 @@ module.exports = { }, /** - * Given a doc, replace the lineage information therein with "replaceWith" + * Given a doc, replace the contact's lineage * - * @param {Object} doc A CouchDB document containing a hierarchy that needs replacing + * @param {Object} doc A CouchDB document containing a contact lineage (eg. contact.parent._id) * @param {Object} params * @param {Object} params.replaceWith The new hierarchy { parent: { _id: 'parent', parent: { _id: 'grandparent' } } * @param {string} params.startingFromId Only the part of the lineage "after" this id will be replaced