Skip to content

Commit 29850c0

Browse files
committed
fix(docs): update agent list descriptions for clarity and consistency in IAssetManager reference
1 parent 631523e commit 29850c0

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

docs/fassets/developer-guides/fassets-list-agents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ All of these functions take two parameters:
3535

3636
And return two values:
3737

38-
- `_agents`: Array of agent information structures.
38+
- `_agents`: Array of agent information structs.
3939
- `_totalLength`: Total number of agents in the system (used for pagination).
4040

4141
:::tip Index Parameters

docs/fassets/reference/IAssetManager.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Parameters:
111111

112112
Returns:
113113

114-
- `_agents`: The list of all agents.
114+
- `_agents`: The list of agents between the `_start` and `_end` indexes.
115115
- `_totalLength`: The total length of the all agents list.
116116

117117
```solidity
@@ -126,12 +126,12 @@ Returns the list of available agents.
126126

127127
Parameters:
128128

129-
- `_start`: First index to return from the available agent's list.
130-
- `_end`: End index (one above last) to return from the available agent's list.
129+
- `_start`: First index to return from the available agent's list (inclusive).
130+
- `_end`: End index (one above last) to return from the available agent's list (exclusive).
131131

132132
Returns:
133133

134-
- `_agents`: The list of available agents.
134+
- `_agents`: The list of available agents between the `_start` and `_end` indexes.
135135
- `_totalLength`: The total length of the available agents list.
136136

137137
```solidity
@@ -146,8 +146,8 @@ Returns the list of available agents with extra information about agents like fe
146146

147147
Parameters:
148148

149-
- `_start`: First index to return from the available agent's list.
150-
- `_end`: End index (one above last) to return from the available agent's list.
149+
- `_start`: First index to return from the available agent's list (inclusive).
150+
- `_end`: End index (one above last) to return from the available agent's list (exclusive).
151151

152152
Returns:
153153

@@ -168,13 +168,13 @@ Returns the redemption queue in the form of an array of [`RedemptionTicketInfo`]
168168

169169
Parameters:
170170

171-
- `_firstRedemptionTicketId`: the ticket id to start listing from; if `0`, starts from the beginning.
172-
- `_pageSize`: the maximum number of redemption tickets to return.
171+
- `_firstRedemptionTicketId`: The ticket id to start listing from; if `0`, starts from the beginning.
172+
- `_pageSize`: The maximum number of redemption tickets to return.
173173

174174
Returns:
175175

176-
- `_queue`: the (part of) the redemption queue; maximum length is \_pageSize.
177-
- `_nextRedemptionTicketId`: works as a cursor - if the `_pageSize` is reached and there are more tickets, it is the first ticket id not returned; if the end is reached, it is 0.
176+
- `_queue`: The (part of) redemption queue; maximum length is \_pageSize.
177+
- `_nextRedemptionTicketId`: Works as a cursor - if the `_pageSize` is reached and there are more tickets, it is the first ticket id not returned; if the end is reached, it is 0.
178178

179179
```solidity
180180
function redemptionQueue(
@@ -190,14 +190,14 @@ Returns the redemption queue for specific agent in the form of an array of [`Red
190190

191191
Parameters:
192192

193-
- `_agentVault`: the agent vault address of the queried agent.
194-
- `_firstRedemptionTicketId`: the ticket id to start listing from; if `0`, starts from the beginning.
195-
- `_pageSize`: the maximum number of redemption tickets to return.
193+
- `_agentVault`: The agent vault address of the queried agent.
194+
- `_firstRedemptionTicketId`: The ticket id to start listing from; if `0`, starts from the beginning.
195+
- `_pageSize`: The maximum number of redemption tickets to return.
196196

197197
Returns:
198198

199-
- `_queue`: the (part of) the redemption queue; maximum length is \_pageSize.
200-
- `_nextRedemptionTicketId`: works as a cursor - if the` _pageSize` is reached and there are more tickets, it is the first ticket id not returned; if the end is reached, it is 0.
199+
- `_queue`: The (part of) the redemption queue; maximum length is \_pageSize.
200+
- `_nextRedemptionTicketId`: Works as a cursor - if the` _pageSize` is reached and there are more tickets, it is the first ticket id not returned; if the end is reached, it is 0.
201201

202202
```solidity
203203
function agentRedemptionQueue(

0 commit comments

Comments
 (0)