search

XRPLF / xrpl-py

A Python library to interact with the XRP Ledger (XRPL) blockchain
ISC License
144 stars 83 forks source link

docs: Deprecate the underlying send_reliable_submission #589

Closed JST5000 closed 1 year ago

JST5000 commented 1 year ago

High Level Overview of Change

Title says it all.

Context of Change

submit_and_wait is the newer version of that function with more features & future support.

Note: I moved the internals of send_reliable_submission into a private helper because submit_and_wait relies on that functionality, but should not trigger deprecation warnings each time it's called. (Basically separating the "public face" which is deprecated, from the helper)

Type of Change

Test Plan

CI Passes (and does NOT mention the deprecation - I checked beforehand to verify the deprecation was working, but don't want to clog the logs going forward)

JST5000 commented 1 year ago

Why deprecate it and not just delete it? It's an easy enough migration for people using it who are upgrading to 2.0.

The thought process was that this is the most commonly used function, and so we were worried that people wouldn't update if it was changed.

That being said - it is just a search + replace, so I see it being fine either way.

JST5000 commented 1 year ago

Closing since we've decided to remove send_reliable_submission instead of deprecating. Will open a separate PR and link here afterwards.