better comments

cytoscape · Sep 2, 2022 · 91316c7 · 91316c7
1 parent d71596b
commit 91316c7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ var defaults = {
   boundingBox: undefined, // constrain layout bounds; { x1, y1, x2, y2 } or { x1, y1, w, h }
   transform: function( node, pos ){ return pos; }, // a function that applies a transform to the final node position
   ready: function(){}, // on layoutready
-  sort: undefined, // cytoscape sort function to sort the nodes and edges
+  sort: undefined, // a sorting function to order the nodes and edges; e.g. function(a, b){ return a.data('weight') - b.data('weight') }
   stop: function(){} // on layoutstop
 };
 ```

diff --git a/src/defaults.js b/src/defaults.js
@@ -24,7 +24,7 @@ let defaults = {
   boundingBox: undefined, // constrain layout bounds; { x1, y1, x2, y2 } or { x1, y1, w, h }
   transform: function( node, pos ){ return pos; }, // a function that applies a transform to the final node position
   ready: function(){}, // on layoutready
-  sort: undefined, // cytoscape sort function to sort the nodes and edges
+  sort: undefined, // a sorting function to order the nodes and edges; e.g. function(a, b){ return a.data('weight') - b.data('weight') }
   stop: function(){} // on layoutstop
 };