Skip to content

Commit a9e1957

Browse files
committed
tiny edits
1 parent a7350dd commit a9e1957

File tree

7 files changed

+17
-16
lines changed

7 files changed

+17
-16
lines changed

apps/api-reference/src/apis/evm/get-ema-price-no-older-than.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ it has been updated sufficiently recently.
1111
1212
The caller provides an **\`age\`** argument that specifies how old the price can be.
1313
14-
The \`price\` object contains the following fields:
14+
The price object contains the following fields:
1515
1. \`price\`: The latest price of the price feed.
1616
2. \`conf\`: The confidence level of the price feed.
1717
3. \`expo\`: The exponent of the price feed.
@@ -27,7 +27,7 @@ Sample \`price\` object:
2727
}
2828
\`\`\`
2929
30-
The price above is in the format of \`price * 10^expo\`. So, the price in above
30+
The \`price\` above is in the format of \`price * 10^expo\`. So, the \`price\` in above
3131
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
3232
this case.
3333

apps/api-reference/src/apis/evm/get-ema-price-unsafe.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export const getEmaPriceUnsafe = readApi<"id">({
1212
caller's responsibility to check the returned \`publishTime\` to ensure that the
1313
update is recent enough for their use case. If you need the latest price, update the price using [\`updatePriceFeeds()\`](updatePriceFeeds) and then call [\`getEmaPrice()\`](getEmaPrice).
1414
15-
The \`price\` object contains the following fields:
15+
The price object contains the following fields:
1616
1. \`price\`: The latest price of the price feed.
1717
2. \`conf\`: The confidence level of the price feed.
1818
3. \`expo\`: The exponent of the price feed.
@@ -28,7 +28,7 @@ export const getEmaPriceUnsafe = readApi<"id">({
2828
}
2929
\`\`\`
3030
31-
The price above is in the format of \`price * 10^expo\`. So, the price in above
31+
The \`price\` above is in the format of \`price * 10^expo\`. So, the \`price\` in above
3232
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
3333
this case.
3434

apps/api-reference/src/apis/evm/get-ema-price.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export const getEmaPrice = readApi<"id">({
1313
3. \`expo\`: The exponent of the price feed.
1414
4. \`publishtime\`: The time when the price feed was last updated.
1515
16-
Sample \`price\` object:
16+
Sample price object:
1717
\`\`\`json
1818
{
1919
price: 123456789,
@@ -23,7 +23,7 @@ export const getEmaPrice = readApi<"id">({
2323
}
2424
\`\`\`
2525
26-
The price above is in the format of \`price * 10^expo\`. So, the price in above
26+
The \`price\` above is in the format of \`price * 10^expo\`. So, the \`price\` in above
2727
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
2828
this case.
2929

apps/api-reference/src/apis/evm/get-price-no-older-than.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ it has been updated sufficiently recently.
1111
1212
The caller provides an **\`age\`** argument that specifies how old the price can be.
1313
14-
The \`price\` object contains the following fields:
14+
The price object contains the following fields:
1515
1. \`price\`: The latest price of the price feed.
1616
2. \`conf\`: The confidence level of the price feed.
1717
3. \`expo\`: The exponent of the price feed.
@@ -27,7 +27,7 @@ Sample \`price\` object:
2727
}
2828
\`\`\`
2929
30-
The price above is in the format of \`price * 10^expo\`. So, the price in above
30+
The \`price\` above is in the format of \`price * 10^expo\`. So, the \`price\` in above
3131
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
3232
this case.
3333

apps/api-reference/src/apis/evm/get-price-unsafe.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export const getPriceUnsafe = readApi<"id">({
1212
caller's responsibility to check the returned \`publishTime\` to ensure that the
1313
update is recent enough for their use case. If you need the latest price, update the price using [\`updatePriceFeeds()\`](updatePriceFeeds) and then call [\`getPrice()\`](getPrice).
1414
15-
The \`price\` object contains the following fields:
15+
The price object contains the following fields:
1616
1. \`price\`: The latest price of the price feed.
1717
2. \`conf\`: The confidence level of the price feed.
1818
3. \`expo\`: The exponent of the price feed.
@@ -28,7 +28,7 @@ export const getPriceUnsafe = readApi<"id">({
2828
}
2929
\`\`\`
3030
31-
The price above is in the format of \`price * 10^expo\`. So, the price in above
31+
The \`price\` above is in the format of \`price * 10^expo\`. So, the \`price\` in above
3232
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
3333
this case.
3434

apps/api-reference/src/apis/evm/get-price.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export const getPrice = readApi<"id">({
77
description: `
88
This method returns the latest price object for the requested price feed ID.
99
10-
The \`price\` object contains the following fields:
10+
The price object contains the following fields:
1111
1. \`price\`: The latest price of the price feed.
1212
2. \`conf\`: The confidence level of the price feed.
1313
3. \`expo\`: The exponent of the price feed.
@@ -23,7 +23,7 @@ Sample \`price\` object:
2323
}
2424
\`\`\`
2525
26-
The price above is in the format of \`price * 10^expo\`. So, the price in above
26+
The \`price\` above is in the format of \`price * 10^expo\`. So, the \`price\` in above
2727
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
2828
this case.
2929

apps/api-reference/src/apis/evm/get-valid-time-period.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ export const getValidTimePeriod = readApi<never>({
55
summary: "Get the default valid time period of price freshness in seconds.",
66
description: `
77
This method returns the default valid time period of price freshness in **seconds**.
8-
This quantity is the maximum age of price updates returned by functions like [getPrice](getPrice) and
9-
[getEmaPrice](getEmaPrice); these functions revert if the current on-chain price
10-
is older than this period. The valid time period is configured to be a sane
11-
default for each blockchain.
8+
This quantity is the maximum age of price updates returned by functions like [getPrice](getPrice) and
9+
[getEmaPrice](getEmaPrice); these functions revert if the current on-chain price
10+
is older than this period.
11+
12+
The valid time period is configured to be a same default for each blockchain.
1213
`,
1314
parameters: [],
1415
code: [

0 commit comments

Comments
 (0)