jeetsukumaran / DendroPy

A Python library for phylogenetic scripting, simulation, data processing and manipulation.
https://pypi.org/project/DendroPy/.
BSD 3-Clause "New" or "Revised" License
205 stars 63 forks source link

Improved docstring for src/dendropy/datamodel/treemodel/_tree.py/reroot_at_edge #205

Closed terrycojones closed 1 month ago

terrycojones commented 1 month ago

The current docstring says

``length1`` and ``length2`` will be assigned to the new (sub-)edge leading
        to the old parent of the original edge, while ``length2`` will be
        assigned to the old child of the original edge.

which is clearly(?) wrong, since length2 is mentioned twice.

codecov-commenter commented 1 month ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.70%. Comparing base (a065e61) to head (fdccde6). Report is 2 commits behind head on main.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #205 +/- ## ======================================= Coverage 88.70% 88.70% ======================================= Files 114 114 Lines 12817 12817 ======================================= Hits 11369 11369 Misses 1448 1448 ``` | [Flag](https://app.codecov.io/gh/jeetsukumaran/DendroPy/pull/205/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jeet+Sukumaran) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/jeetsukumaran/DendroPy/pull/205/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jeet+Sukumaran) | `88.70% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jeet+Sukumaran#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mmore500 commented 1 month ago

Good catch! Thanks for the fix.