Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix some comments #171

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: fix some comments #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/html/types/ParaSwapVersion.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<h1>Type alias ParaSwapVersion</h1></div>
<div class="tsd-signature">Para<wbr/>Swap<wbr/>Version<span class="tsd-signature-symbol">:</span> <a href="_internal_.EnumerateLiteral.html" class="tsd-signature-type" data-tsd-kind="Type alias">EnumerateLiteral</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">typeof </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../enums/_internal_.ParaSwapVersion.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ParaSwapVersion</a><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-comment tsd-typography">
<h3>Description</h3><p>Passed to version API enpoints as ?version: to /prices and /adapters</p>
<h3>Description</h3><p>Passed to version API endpoints as ?version: to /prices and /adapters</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/types.ts#L34">src/types.ts:34</a></li></ul></aside></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/md/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1168,7 +1168,7 @@ ___

**`Description`**

Passed to version API enpoints as ?version: to /prices and /adapters
Passed to version API endpoints as ?version: to /prices and /adapters

#### Defined in

Expand Down
2 changes: 1 addition & 1 deletion jest.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
moduleNameMapper: {
// force resolve `axios` mopdule as CommonJS
// force resolve `axios` module as CommonJS
// axios@>1.0.0 breaks in jest otherwise
'^axios$': require.resolve('axios'),
},
Expand Down
2 changes: 1 addition & 1 deletion src/methods/limitOrders/helpers/buildOrderData.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export function buildOrderData({
takerAmount,
maker,
AugustusAddress,
// if taker is specified -- p2p order for that taker only to fill through Augustus (v5) or direcly (v6)-- taker = Augustus | _taker, takerInNonce = _taker
// if taker is specified -- p2p order for that taker only to fill through Augustus (v5) or directly (v6)-- taker = Augustus | _taker, takerInNonce = _taker
// if taker is not specified -- limitOrder for anyone to fill through Augustus or not -- taker = Zero, takerInNonce = Zero
taker: takerInNonce = ZERO_ADDRESS,
// if given, overrides the above choices made based on `taker`
Expand Down
2 changes: 1 addition & 1 deletion src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ type EnumerateLiteral<T extends Record<string, any>> = {
// `alpha`,`beta` and other non-numbers can be used
// allowing enum only forces users to import and pass that enum

/** @description Passed to version API enpoints as ?version: to /prices and /adapters */
/** @description Passed to version API endpoints as ?version: to /prices and /adapters */
export type ParaSwapVersionUnion = EnumerateLiteral<typeof ParaSwapVersion>;

export interface ConstructBaseInput {
Expand Down