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.

Sign up for GitHub

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

Jump to bottom

User friendly error messages #193

Merged
merged 15 commits into from
Dec 17, 2024
Merged

User friendly error messages #193

merged 15 commits into from
Dec 17, 2024

Conversation

MustafaJafar
Copy link
Contributor

@MustafaJafar MustafaJafar commented Dec 12, 2024 •
edited
Loading

Changelog Description

resolve #108

These changes affect only publish plugins where we:

  1. Update the error messages.
  2. Errors related to user should raise PublishError with a clear message about what a user should do to fix the problem.
  3. Errors that are not related user should raise KnownPublishError (This change might be reverted).
  4. Avoid capturing any errors from lib functions e.g. get_output_parameter, render_rop and etc.

Testing notes:

  1. Everything should still work as before
  2. Error messages related to the changes should be better.

@MustafaJafar MustafaJafar requested review from BigRoy, iLLiCiTiT and moonyuet and removed request for BigRoy December 12, 2024 22:14
@MustafaJafar MustafaJafar self-assigned this Dec 12, 2024
@MustafaJafar MustafaJafar added the type: enhancement Improvement of existing functionality or minor addition label Dec 12, 2024
@MustafaJafar MustafaJafar changed the title Refactor errors to AYON errors User friendly error messages Dec 12, 2024
@MustafaJafar MustafaJafar mentioned this pull request Dec 12, 2024
Closed
4 tasks
@MustafaJafar MustafaJafar mentioned this pull request Dec 12, 2024
Open
1 task
@MustafaJafar MustafaJafar requested a review from BigRoy December 16, 2024 17:33
@MustafaJafar MustafaJafar mentioned this pull request Dec 16, 2024
Open
1 task
@MustafaJafar MustafaJafar requested a review from BigRoy December 17, 2024 10:25
@MustafaJafar
Copy link
Contributor Author

For reference, here are some screenshots of the result of my last commits.
image
image

BigRoy
BigRoy approved these changes Dec 17, 2024
View reviewed changes
Copy link
Contributor

@BigRoy BigRoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me - just some minor cosmetic notes.

moonyuet
moonyuet approved these changes Dec 17, 2024
View reviewed changes
Copy link
Member

@moonyuet moonyuet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me after testing in Houdini

@moonyuet
Copy link
Member

@MustafaJafar resolve the conflict before the merge. Thanks!

@MustafaJafar MustafaJafar merged commit 373a457 into develop Dec 17, 2024
1 check passed
@MustafaJafar MustafaJafar deleted the enhancement/108-refactor-runtimeerrors-to-publisherrors branch December 17, 2024 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@moonyuet moonyuet moonyuet approved these changes

@BigRoy BigRoy BigRoy approved these changes

@iLLiCiTiT iLLiCiTiT Awaiting requested review from iLLiCiTiT

Assignees

@MustafaJafar MustafaJafar

Labels
type: enhancement Improvement of existing functionality or minor addition
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Refactor RuntimeErrors to PublishErrors
4 participants
@MustafaJafar @moonyuet @BigRoy @iLLiCiTiT