docs: link QuoteRequest fields to their RouteOptions docs - #586
Merged
Merged
Conversation
🦋 Changeset detectedLatest commit: a1bae31 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which Linear task is linked to this PR?
Part of EXBE-617
Why was it implemented this way?
QuoteRequest.order,slippage,fee,integratorandreferrerhad no doc comment, while the same fields onRouteOptions/RouteOptionsBaseare documented (default order, slippage as a decimal proportion, fee meaning, …). This adds@seelinks, the pattern the neighbouring fields (refundAddress,disableFees,distributionFees) already use, so editor hovers onQuoteRequestshow the real docs.Only doc comments change: the emitted
.jsis identical and the.d.tsdiff is five/** @see … */lines.It is also the first release through the new Changesets pipeline (#585): after merge, CI opens the chore: version packages PR (18.12.0 → 18.12.1), and merging that publishes 18.12.1 with a
v18.12.1tag and a GitHub Release.Checklist before requesting a review
pnpm changeset), or this PR does not change the published package.