Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add troubleshooting page #603

wants to merge 1 commit into from

Conversation

penelopeysm
Copy link
Member

@penelopeysm penelopeysm commented May 21, 2025

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 chose T because the error comes from Turing.jl; something in DynamicPPL would be D0001, 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

Copy link
Contributor

Preview the changes: https://turinglang.org/docs/pr-previews/603
Please avoid using the search feature and navigation bar in PR previews!

@penelopeysm penelopeysm force-pushed the py/troubleshooting branch 2 times, most recently from 9af2667 to f43bb30 Compare May 21, 2025 14:50
@penelopeysm penelopeysm requested a review from mhauru May 21, 2025 14:59
@penelopeysm
Copy link
Member Author

penelopeysm commented May 21, 2025

I'll fix the version consistency thing after this PR, since that's just an annoying operation that will require rebuilding the entire docs and takes 2 hours.
Done.

@mhauru
Copy link
Member

mhauru commented May 22, 2025

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:

  • The error you get when you forget to do x = Vector{T} and just do x = Vector{Float64} and AD falls over.
  • I thought I had a second one in mind but I don't.

@penelopeysm penelopeysm force-pushed the py/troubleshooting branch from f43bb30 to b6112f4 Compare May 28, 2025 00:58
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

Successfully merging this pull request may close these issues.

2 participants