-
Notifications
You must be signed in to change notification settings - Fork 239
Add Discourse and GitHub links to deprecation warnings #7123
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
base: main
Are you sure you want to change the base?
Conversation
|
I am not sure this is good idea. @ShivamRajSri has this been discussed somewhere? |
|
Thanks for the feedback, @danielhollas! |
|
I see. There is a bit of a misunderstanding of the issu, this should not be added to the deprecation message. Rather, the Github/Discourse links should be added to the already existing |
|
Thanks a lot for the clarification, @danielhollas! |
|
Thanks for clarifying, @danielhollas! |
|
Hi @danielhollas |
Add Discourse and GitHub links to deprecation warnings
Removed additional warning details from deprecation message.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7123 +/- ##
=======================================
Coverage 79.60% 79.60%
=======================================
Files 566 566
Lines 43587 43587
=======================================
Hits 34694 34694
Misses 8893 8893 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
danielhollas
left a comment
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.
Hi @ShivamRajSri,
thanks for the ping! There are two more places to modify
$ cd src/aiida
$ git grep Discourse
cmdline/commands/cmd_group.py: 'If you encounter unexpected behavior or bugs, please report them via Discourse or GitHub.'
cmdline/commands/cmd_process.py: 'If you encounter unexpected behavior or bugs, please report them via Discourse or GitHub.'
cmdline/commands/cmd_profile.py: 'If you encounter unexpected behavior or bugs, please report them via Discourse or GitHub.'Also the code needs to be formatted. We use the ruff autoformatter which you can run with pre-commit. I'd recommend installing uv (to handle dependencies instead of pip) and then doing
uv run pre-commit run -a ruff-formatLet me know if you run into issues.
|
Hi @danielhollas, |
|
Thanks for the pointers, @danielhollas! 🙏 |
danielhollas
left a comment
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.
@ShivamRajSri thank you, this looks good now! Thanks for your work. 💪
I'll leave final approve to @agoscinski since he's the one who originally created the issue.
|
Thanks a lot, @danielhollas! |
This PR improves the deprecation warning message shown by warn_deprecation() in aiida/common/warnings.py.
It now includes links to AiiDA’s Discourse forum and GitHub issue tracker so that users can more easily report bugs or unexpected behavior.
Example output:
This feature is deprecated (this will be removed in v3)
If you encounter unexpected behavior or bugs, please report them via:
Discourse: https://aiida.discourse.group
GitHub: https://github.com/aiidateam/aiida-core/issues
Closes #6912