Add troubleshooting page #603
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #583 for motivation. The idea is to have a dedicated page to the error messages that people receive and provide some guidance. It starts with only one error, but we can add to it as we go along.
Preview here: https://turinglang.org/docs/pr-previews/603/usage/troubleshooting/
I do suppose it's not mandatory to come up with error codes like
T0001
(in this case, I choseT
because the error comes from Turing.jl; something in DynamicPPL would beD0001
, for example).However, I think that error codes are more stable and easier to search for than error messages (which may be changed, and may vary depending on interpolated variables).
The intent would be that after adding a code here, we can edit the message in the Turing codebase to point to this link