doc: clarify that we use natural logarithms for entropies

igraph · Feb 19, 2024 · 055e836 · 055e836
1 parent 03f9faa
commit 055e836
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/igraph/clustering.py b/src/igraph/clustering.py
@@ -1459,6 +1459,9 @@ def _ensure_list(obj):
 def compare_communities(comm1, comm2, method="vi", remove_none=False):
     """Compares two community structures using various distance measures.
 
+    For measures involving entropies (e.g., the variation of information metric),
+    igraph uses natural logarithms.
+
     B{References}
 
       - Meila M: Comparing clusterings by the variation of information. In: