Merge pull request #3032 from hyanwong/rf-docs

Document rf_distance()
tskit-dev · Oct 16, 2024 · 05f8bef · 05f8bef
2 parents baac2aa + 3f1cf47
commit 05f8bef
Show file tree

Hide file tree

Showing 5 changed files with 1,418 additions and 1,391 deletions.
diff --git a/docs/python-api.md b/docs/python-api.md
@@ -598,6 +598,7 @@ Functions and static methods
 ```{eval-rst}
 .. autosummary::
   Tree.kc_distance
+  Tree.rf_distance
 ```
 
 (sec_python_api_trees_balance)=

diff --git a/python/CHANGELOG.rst b/python/CHANGELOG.rst
@@ -93,6 +93,8 @@
 
 - Add ``resources`` section to provenance schema. (:user:`benjeffery`, :pr:`3016`)
 
+- Add ``Tree.rf_distance`` method to calculate the unweighted Robinson-Foulds distance
+  between two trees. (:user:`Billyzhang1229`, :issue:`995`, :pr:`2643`, :pr:`3032`)
 
 --------------------
 [0.5.8] - 2024-06-27