Skip to content

Clarify that Validate is compile-only and dynamic member checks may still fail at runtime #76

@djdcks12

Description

@djdcks12

Description

The new Validate button compiles the current snippet without executing it. This is useful and safe, but it can be misunderstood as "this code is guaranteed to run."

Because _ and named pins are exposed as dynamic, some member accesses are not fully checked until runtime. For example, a snippet using player.SomeMissingMember may pass Validate if player is dynamic, then fail when Run actually invokes the code.

Why

Users may rely on Validate before running side-effectful snippets or patches. The distinction between compile success and runtime success should be explicit.

Suggested Fix

Add a short note in the README and/or Validate tooltip/status copy:

Validate only checks compilation. Code that uses dynamic values such as _ or named pins may still fail at runtime when Run executes it.

This should not be over-explained in the UI. A short README note plus tooltip text is enough.

Acceptance Criteria

  • Validate documentation states that it does not execute code.
  • Validate documentation states that runtime errors can still happen.
  • Dynamic _ / named pin member access is specifically mentioned.
  • UI tooltip or nearby text does not imply Validate guarantees runtime success.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions