Skip to content

fix: add comprehensive JSDoc to extractRouting decision engine#197

Open
Yusufolosun wants to merge 1 commit intoBoxkit-Labs:mainfrom
Yusufolosun:fix/extract-routing-jsdoc
Open

fix: add comprehensive JSDoc to extractRouting decision engine#197
Yusufolosun wants to merge 1 commit intoBoxkit-Labs:mainfrom
Yusufolosun:fix/extract-routing-jsdoc

Conversation

@Yusufolosun
Copy link
Copy Markdown

Closes #186

Summary

Adds maintainer-grade JSDoc for extractRouting so IDE hover clearly explains routing behavior and decision precedence.

Root Cause

extractRouting lacked function-level JSDoc, leaving behavior across M-address routing, G-address memo routing, and non-routable memo states undocumented at the call site.

Fix

Added a single comprehensive JSDoc block above extractRouting in extract.ts covering:

  • Inputs and return values
  • Branch logic for M and G addresses
  • Memo-type handling
  • Warning behavior and output guarantees

No runtime logic was changed.

Testing

  • ✅ No new file-level errors introduced by this change

@codeZe-us
Copy link
Copy Markdown
Contributor

@Yusufolosun please fix conflict

@codeZe-us
Copy link
Copy Markdown
Contributor

@Yusufolosun please i do not understand this PR, it holds alot of irrelevant code that are outside the task you were been assigned to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add JSDoc to extractRouting()

2 participants