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

Start documenting diagnostics #3

Open
voltrevo opened this issue Mar 8, 2023 · 0 comments
Open

Start documenting diagnostics #3

voltrevo opened this issue Mar 8, 2023 · 0 comments
Labels

Comments

@voltrevo
Copy link
Owner

voltrevo commented Mar 8, 2023

Diagnostics are errors/lints/etc that the toolchain emits when processing input. Like this:

➜  ValueScript git:(main) vstc run inputs/passing/captureMutated.ts     
inputs/passing/captureMutated.ts:2:7: Lint: `x` should be declared using `const` because it is implicitly const due to capture
inputs/passing/captureMutated.ts:3:3: Error: Cannot mutate captured variable `x`

Failed with 1 error(s)

Every diagnostic should have an extended description. Start this process by creating docs/diagnostics/cap-const.md and docs/diagnostics/cap-mutate.md.

Include at least one small but complete program that generates the diagnostic on each diagnostic page.

Include something like this on each of these pages:

If you're having trouble resolving this error, you can search the issues for it or create a new one.

@voltrevo voltrevo added the good first issue Good for newcomers label Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant