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

Replace recommendations in warning messages with link to website #505

Closed
jgabry opened this issue May 20, 2021 · 5 comments
Closed

Replace recommendations in warning messages with link to website #505

jgabry opened this issue May 20, 2021 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation feature New feature or request

Comments

@jgabry
Copy link
Member

jgabry commented May 20, 2021

@martinmodrak @andrewgelman @avehtari and I are working on the content for a webpage that will have recommendations for how to proceed after seeing Stan's various warning messages (basically it's an improved (and non rstan-specific) version of http://mc-stan.org/misc/warnings). This will allow us to remove the recommendations from the warning messages themselves and instead point to the website. Three of the advantages of this are:

  • we can keep improving the recommendations without having to keep changing the warning messages
  • we can put more thorough recommendations than we can fit in warning messages
  • multiple interfaces can point to the same webpage

For now there's no action necessary for CmdStanR, but as soon as the website is ready we can address this issue.

@jgabry jgabry added documentation Improvements or additions to documentation feature New feature or request labels Jun 17, 2021
@jgabry jgabry added this to the v1.0.0 - release milestone Jun 17, 2021
@jgabry jgabry self-assigned this Aug 24, 2021
@jgabry
Copy link
Member Author

jgabry commented Nov 2, 2021

@avehtari @martinmodrak @andrewgelman Any updates on this website? Is there anything I can do to help get us closer? I ask because we're about to add E-BFMI warnings to CmdStanR (see #500) to go along with the current checks for divergences and treedepth problems, but I'm mindful of the fact that we still don't have anywhere to direct the users when they see these warnings.

@jgabry jgabry mentioned this issue Nov 2, 2021
2 tasks
@martinmodrak
Copy link
Contributor

My conclusion from the last discussion with @avehtari is that the current draft is satsifactory except for the "What are divergences" appendix that needs a bit more work. So I think we can definitely make the draft into a public page without the appendix almost immediately (it might be useful to ask for additional feedback on Discourse before that).

@jgabry
Copy link
Member Author

jgabry commented Nov 3, 2021

Ok great, thanks Martin!

(it might be useful to ask for additional feedback on Discourse before that).

By "before that", do you mean before making it public or before adding the divergences appendix?

@martinmodrak
Copy link
Contributor

I meant before making the document public and start linking to it from error messages.

@jgabry
Copy link
Member Author

jgabry commented Nov 3, 2021

Ok cool, that makes sense. @avehtari What do you think? Are you ok with soliciting comments about the current draft on discourse at this point?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants