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

More helpful message on how to handle deprecations #626

Closed
rok-cesnovar opened this issue Feb 16, 2022 · 3 comments
Closed

More helpful message on how to handle deprecations #626

rok-cesnovar opened this issue Feb 16, 2022 · 3 comments
Labels
feature New feature or request

Comments

@rok-cesnovar
Copy link
Member

With deprecated syntax, stanc3 in 2.29 prints out this warning:

Warning in '/tmp/RtmpfALmCi/model-1d8e6aeb78c2.stan', line 6, column 18: normal_log
    is deprecated and will be removed in Stan 2.32.0. Use normal_lpdf
    instead. This can be automatically changed using the canonicalize flag
    for stanc

As @avehtari mentioned, the suggestion could be more helpful. We can't change what stanc3 prints, nor can we have stanc3 spit out a helpful warning for all possible interfaces.

I think the best plan would be to:

  • add a vignette on how to address deprecations
  • catch if any stanc3 message mentions deprecations and print an R warning pointing to the online vignette
@rok-cesnovar rok-cesnovar added the feature New feature or request label Feb 16, 2022
@jgabry
Copy link
Member

jgabry commented Feb 16, 2022

Sounds good to me!

@jgabry jgabry added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 7, 2022
@rok-cesnovar
Copy link
Member Author

A draft of this vignette is now available here: https://rok-cesnovar.github.io/cmdstanr/articles/deprecations.html

The corresponding PR is available here: #644 Comments/suggestions are very welcome.

Once that is merged I will include the URL in the warning message.

@rok-cesnovar rok-cesnovar added this to the v1.0.0 - release milestone Apr 9, 2022
@jgabry
Copy link
Member

jgabry commented Apr 22, 2024

I think this can be closed now, but if not feel free to reopen.

@jgabry jgabry closed this as completed Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants