-
Notifications
You must be signed in to change notification settings - Fork 104
Add troubleshooting page #603
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
Conversation
Preview the changes: https://turinglang.org/docs/pr-previews/603 |
9af2667
to
f43bb30
Compare
|
I think this is a great idea. Might be worth bringing this to @yebai's attention as well, since it's an entirely new aspect of documentation. Some ideas for errors to write troubleshooting bits for:
|
f43bb30
to
b6112f4
Compare
Did you have thoughts on this @yebai? |
I like the idea of a new doc page for troubleshooting, but the error code will not help much. It reminds me of some weird Windows OS error codes, which are generally not very helpful. Google is very good nowadays, so searching for an error message is generally not that difficult. |
Okay, I don't mind skipping the numeric code -- I'd like to put a direct link to this in the error message, so that should be enough too. |
@mhauru Further thoughts or approval welcome |
Maybe also update the manifest to fix the version consistency check? |
Ah, my fault for releasing yet another patch version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @penelopeysm!
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