Skip to content

Commit 174b508

Browse files
authored
Fix @field doc by adding a missing '?' on the 'name' (#27)
Also added a '?' on one line of the examples, just to show how it can be used.
1 parent 14b11b2 commit 174b508

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/content/wiki/annotations.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ Define a field within a table. Should be immediately following a [`@class`](#cla
549549
**Syntax**
550550

551551
<div class="syntax">
552-
`---@field [scope] <name> <type> [description]`
552+
`---@field [scope] <name[?]> <type> [description]`
553553
</div>
554554

555555
It is also possible to allow _any_ key of a certain type to be added using the below:
@@ -573,7 +573,7 @@ It is also possible to allow _any_ key of a certain type to be added using the b
573573
---@field height number The height of this person in cm
574574
---@field weight number The weight of this person in kg
575575
---@field firstName string The first name of this person
576-
---@field lastName string The last name of this person
576+
---@field lastName? string The last name of this person
577577
---@field age integer The age of this person
578578

579579
---@param person Person

0 commit comments

Comments
 (0)