From 4ec73b2d8055ee34eca416ae1217842466f555e7 Mon Sep 17 00:00:00 2001 From: Mike Cumings Date: Thu, 13 Aug 2026 16:50:10 -0700 Subject: [PATCH] Improve docs to resolve #53 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8ef208..316c23c 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Although the plugin is designed to be extensible, it comes with a number of buil | `degree` | The total number of incoming (dependents) and outgoing (dependencies) a project has | | `inDegree` | The number of dependents which depend upon the project | | `outDegree` | The number of dependencies which the project declares | -| `height` | The size of the longest path in the project's tree of dependencies | +| `height` | The number of breadth-first dependency levels from the project down to a leaf. A project with no further project dependencies has height 1. | | `networkAbove` | The total number of dependant projects which depend upon the project. This is useful to understand the number of projects impacted by a change to this project. | | `networkBelow` | The total number of dependency projects which this project depends upon. This is useful to understand the number of projects which would affect this project when changed. | | `betweennessCentrality` | Calculates the [Betweenness Centrality](https://en.wikipedia.org/wiki/Betweenness_centrality) value for the project |