Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify enum documentation #138

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Clarify enum documentation #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/config/types.md
View file
Open in desktop
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