Skip to content

docs: fix distance_sort parameter description in tree_params.py#1081

Open
Carbon14-48 wants to merge 1 commit intomalariagen:masterfrom
Carbon14-48:fix/distance-sort-docstring-typo
Open

docs: fix distance_sort parameter description in tree_params.py#1081
Carbon14-48 wants to merge 1 commit intomalariagen:masterfrom
Carbon14-48:fix/distance-sort-docstring-typo

Conversation

@Carbon14-48
Copy link

What

Fixed the distance_sort parameter description in malariagen_data/anoph/tree_params.py.

Why

The current description has two issues:

  1. "if True" appears twice: "If True, for each node n, if True, the child..."
  2. "distance between" is incomplete — it doesn't say between what.

Fix

  • Removed the duplicated "if True"
  • Clarified that the distance is between the node's direct descendants, consistent with scipy's dendrogram(distance_sort) documentation.

The count_sort description directly above was already correct and served as a reference for the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant