XRPLF / xrpl.js

A JavaScript/TypeScript API for interacting with the XRP Ledger in Node.js and the browser
https://xrpl.org/
1.19k stars 507 forks source link

rectify the flag name tfNoRippleDirect #2647

Closed ckeshava closed 3 months ago

ckeshava commented 4 months ago

High Level Overview of Change

The codebase contains an incorrect flag name tfNoDirectRipple. This is modified to adhere to the documentation as tfNoRippleDirect

Type of Change

Did you update HISTORY.md?

Test Plan

The existing unit tests have been updated to use the correct flag name

ckniffen commented 4 months ago

Probably make a note that this is a small breaking bugfix

ckeshava commented 4 months ago

@ckniffen Should I include a note in the HISTORY.md file? Or are you referring to an API changelog somewhere?

JST5000 commented 4 months ago

@ckeshava Yep that note should be in the HISTORY.md file :)

We usually group changes in categories - the default ones we use as needed are:

Added

Fixed

BREAKING

(Since this is a small breaking change, I'd use the ## BREAKING header and then in the individual note say "- Small fix in the api to use X instead of Y")