Skip to content

Commit

Permalink
Clarify enum documentation (#138)
Browse files Browse the repository at this point in the history
  • Loading branch information
ATK422 authored Dec 2, 2024
1 parent 1f9a77e commit 945e72f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/config/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ outline: [2, 3]
---

<script setup lang="ts">
const enumExample = `enum "Type" {
const enumExample = `type Tagged = enum "Type" {
Number {
Value: f64,
},
Expand Down Expand Up @@ -134,7 +134,7 @@ Zap has two types of enums, unit enums and tagged enums.

Unit enums are used to represent a set of possible values. They are defined using the `enum` keyword, followed by a set of possible string values. For example, a unit enum representing the status of a round would look like:

<CodeBlock code='enum { Starting, Playing, Intermission }' />
<CodeBlock code='type RoundStatus = enum { Starting, Playing, Intermission }' />

This code would then create the Luau type:

Expand Down

0 comments on commit 945e72f

Please sign in to comment.