Skip to content

Fix documentation examples and enum numbering - #398

Merged
aspizu merged 1 commit into
mainfrom
apz/docs
Oct 8, 2026
Merged

aspizu merged 1 commit into
mainfrom
apz/docs

Conversation

@aspizu

@aspizu aspizu commented Oct 8, 2026

Copy link
Copy Markdown
Owner

Correct the documentation examples so declarations and executable statements use valid contexts, keyword function calls compile, and explanations match the compiler's caching, sound validation, macro stringification, and variable namespacing behavior. Update contributor prerequisites, the generated-project tree, and the backdrop block heading.

Advance implicit enum variants after an explicit numeric value. For A = 2, B, B now has value 3 instead of 2.

Validation:

  • Dependency-age check and git diff --check.
  • cargo check --locked and cargo test --locked (12 tests passed).
  • Compiled and schema-validated 12 documentation examples; verified the namespace example errors when the commented say is uncommented.
  • Confirmed the documented mixed enum values in generated project JSON.
  • Strict MkDocs content build with the Git attribution plugin disabled.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-08T18:32:07.761717Z df9dde4 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: df9dde40de

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/contributing.md
rustup toolchain install nightly
```

The development scripts also require Python 3.9 or later, Node.js, and the pnpm

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Raise the documented Python minimum to 3.10

A contributor using the newly documented minimum of Python 3.9 cannot run the documentation workflow: pnpm run build:docs invokes uv run --locked, while pyproject.toml:11 declares requires-python = ">=3.10". Document Python 3.10+ globally, or clarify that 3.9 supports only the utility scripts, so the setup instructions do not lead documentation contributors to an unsupported interpreter.

Useful? React with 👍 / 👎.

Comment thread docs/language/sounds.md
Other formats will (as of now) not raise a warning or error, and the project will
refuse to load in Scratch.
Scratch only supports MP3 and WAV files. goboscript accepts `.mp3`, `.wav`, and
`.wave` file extensions and reports an error for unsupported sound formats.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Qualify unsupported-format errors for sound globs

When a sound declaration uses a wildcard that matches unsupported files, such as sounds "sounds/*.ogg";, this promise is false: visit_assets in src/visitor/pass0.rs:168-176 silently skips every file for which is_sound_ext returns false, so no asset reaches the InvalidSoundFormat diagnostic in code generation. The build therefore succeeds with the sounds omitted despite this documentation promising an error; either report rejected glob matches or clarify that the error applies only to direct paths.

Useful? React with 👍 / 👎.

@aspizu
aspizu merged commit 90da472 into main Oct 8, 2026
1 check passed
@aspizu
aspizu deleted the apz/docs branch October 8, 2026 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant