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
210 stars 61 forks source link

Remove preserve_underscores as an argument in docstring example usages of datamodel.basemodel.Serializable.write #204

Closed terrycojones closed 3 months ago

terrycojones commented 3 months ago

I don't know if there are more instances of this that should also be changed. But passing preserve_underscores to write (as opposed to using when reading) in version 5.0.1 gets me a TypeError:

TypeError: Unrecognized or unsupported arguments: {'preserve_underscores': True}
mmore500 commented 3 months ago

Thanks for bringing this to our attention @terrycojones! Will take a look and follow up shortly 👍

codecov-commenter commented 3 months 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.69%. Comparing base (a065e61) to head (9e2c328).

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

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #204 +/- ## ========================================== - Coverage 88.70% 88.69% -0.01% ========================================== Files 114 114 Lines 12817 12817 ========================================== - Hits 11369 11368 -1 - Misses 1448 1449 +1 ``` | [Flag](https://app.codecov.io/gh/jeetsukumaran/DendroPy/pull/204/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/204/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jeet+Sukumaran) | `88.69% <ø> (-0.01%)` | :arrow_down: | 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 3 months ago

Checked the documentation, and you are correct in catching this. Thanks @terrycojones !