From 117c0b67d726b68e642a82e654c7fec7cbc21729 Mon Sep 17 00:00:00 2001 From: Chad Ostrowski <221614+chadoh@users.noreply.github.com> Date: Mon, 14 Aug 2023 10:56:45 -0400 Subject: [PATCH] docs: fix example in doc comment Re: https://typedoc.org/tags/example/, it is best to use both `@example` and the triple-backtick code block --- .../src/project_template/src/method-options.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cmd/crates/soroban-spec-typescript/src/project_template/src/method-options.ts b/cmd/crates/soroban-spec-typescript/src/project_template/src/method-options.ts index 79f5b1e314..ee547200a1 100644 --- a/cmd/crates/soroban-spec-typescript/src/project_template/src/method-options.ts +++ b/cmd/crates/soroban-spec-typescript/src/project_template/src/method-options.ts @@ -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 }