Skip to content

Commit b3c6d64

Browse files
committed
fix: documentation
1 parent 1bdb129 commit b3c6d64

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

src/procedures/ReclaimFunds.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,17 @@ export const createReclaimFundsResolver = (
2222
};
2323

2424
/**
25-
* Procedure that allows the issuer reclaim remaining unclaimed dividend amounts, for expired dividends
25+
* Procedure that allows the issuer to reclaim dividends after they expire without being claimed by shareholders
2626
*/
2727
export class ReclaimFunds extends Procedure<ReclaimFundsProcedureArgs> {
2828
public type = ProcedureType.ReclaimFunds;
2929

3030
/**
31-
* - Reclaim desired dividend
31+
* Reclaim funds
3232
*
33-
* Note that this procedure will fail if the security token symbol doesn't exist
34-
* Note that this procedure will fail if the dividend feature hasn't been enabled
33+
* Note that this procedure will fail if:
34+
* - The security token symbol doesn't exist
35+
* - The Dividends Feature hasn't been enabled
3536
*/
3637
public async prepareTransactions() {
3738
const { symbol, dividendIndex } = this.args;

0 commit comments

Comments
 (0)