xrpl.js icon indicating copy to clipboard operation
xrpl.js copied to clipboard

rectify the flag name tfNoRippleDirect

Open ckeshava opened this issue 1 year ago • 3 comments

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

  • [x] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [] Refactor (non-breaking change that only restructures code)
  • [x] Tests (You added tests for code that already exists, or your new feature included in this PR)
  • [ ] Documentation Updates
  • [ ] Release

Did you update HISTORY.md?

  • [x] Yes
  • [] No, this change does not impact library users

Test Plan

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

ckeshava avatar Feb 12 '24 21:02 ckeshava

Probably make a note that this is a small breaking bugfix

ckniffen avatar Feb 13 '24 16:02 ckniffen

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

ckeshava avatar Feb 13 '24 16:02 ckeshava

@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")

JST5000 avatar Feb 13 '24 16:02 JST5000