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.

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

Improve spacetime call diagnostics for invalid / ill-typed arguments #2066

Open
cloutiertyler opened this issue Dec 16, 2024 · 0 comments
Open

Comments

@cloutiertyler
Copy link
Contributor

Today (2024-04-10), I (pgoldman) had to hop into a call with the BitCraft team to explain the correct syntax to call a reducer which took a C-style enum as an argument via the CLI. Ideally, the CLI error message should have given them enough information to determine a correct call on their own. Consider:

  • Changing the CLI's parsing to accept strings for C-style enums (They were trying to pass "Admin", when the correct parse was { "Admin": {} }, which is a stupid and unintuitive format).
  • Printing a sample invocation which will parse correctly.
  • Linking the docs for the JSON format used by the CLI.
@cloutiertyler cloutiertyler transferred this issue from clockworklabs/spacetime-docs Dec 16, 2024
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

No branches or pull requests

1 participant