add getEarliestCommonAncestorFrom jsdoc description

2015-06-17 02:40:15 +01:00 · 2015-06-17 02:40:15 +01:00 · f6ff366edf
commit f6ff366edf
parent c7cac7aaba
1 changed files with 5 additions and 1 deletions
--- a/src/babel/traversal/path/ancestry.js
+++ b/src/babel/traversal/path/ancestry.js
@ -28,7 +28,11 @@ export function getStatementParent() {
 }

 /**
- * Description
+ * Get the deepest common ancestor and then from it, get the earliest relationship path
+ * to that ancestor.
+ *
+ * Earliest is defined as being "before" all the other nodes in terms of list container
+ * position and visiting key.
 */

 export function getEarliestCommonAncestorFrom(paths: Array<NodePath>): NodePath {