Skip to content

Commit

Permalink
docs: fix example in doc comment
Browse files Browse the repository at this point in the history
Re: https://typedoc.org/tags/example/, it is best to use both `@example`
and the triple-backtick code block
  • Loading branch information
chadoh committed Aug 14, 2023
1 parent fdfc5d6 commit 117c0b6
Showing 1 changed file with 2 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ export type ClassOptions = {
/**
* A Wallet interface, such as Freighter, that has the methods `isConnected`, `isAllowed`, `getUserInfo`, and `signTransaction`. If not provided, will attempt to import and use Freighter. Example:
*
* @example
* ```ts
* import freighter from "@stellar/freighter-api";
*
* // later, when calling this function:
* wallet: freighter,
* ```
*/
wallet?: Wallet
}
Expand Down

0 comments on commit 117c0b6

Please sign in to comment.