Skip to content

Commit

Permalink
Fix @field doc by adding a missing '?' on the 'name' (#27)
Browse files Browse the repository at this point in the history
Also added a '?' on one line of the examples, just to show how it can be used.
  • Loading branch information
EduYukio authored Mar 20, 2024
1 parent 14b11b2 commit 174b508
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/content/wiki/annotations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ Define a field within a table. Should be immediately following a [`@class`](#cla
**Syntax**

<div class="syntax">
`---@field [scope] <name> <type> [description]`
`---@field [scope] <name[?]> <type> [description]`
</div>

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

---@param person Person
Expand Down

0 comments on commit 174b508

Please sign in to comment.