Document AnalysisError

[dsavchenko]

No description provided.

[burnout87]

What do you think?

[volodymyrss]

I would kindly ask few more people who are the likely users of this feature to review the change. I add them in reviewers. Could you please help?

[ferrigno]

the sentence "is show below is shown below" is a leftover at line 233.

I do not understand why one should define a class, is you raise an exception is it not caught?
The lack of indentation does not allow me to understand if the "try: except is within the class or not. Maybe linking a usage example would be useful.

[dsavchenko]

I do not understand why one should define a class, is you raise an exception is it not caught?
The lack of indentation does not allow me to understand if the "try: except is within the class or not. Maybe linking a usage example would be useful.

The indentation is not lacking here. This is a screenshot from the actual usage example: a Fermi notebook. Maybe using Ellipsis ... confuses you here. I will update the screenshot with equivalent syntax using pass.

The idea of the dedicated class is to distinguish a properly handled exception in the notebook from the unexpected ones.
We do it actually for our own convenience, because we don't want this type of exceptions to appear in Sentry.

[ferrigno]

The indentation is not lacking here. This is a screenshot from the actual usage example: a Fermi notebook. Maybe using Ellipsis ... confuses you here. I will update the screenshot with equivalent syntax using pass.

Indeed, it was confusing, maybe you can link the example notebook if not done already.

The idea of the dedicated class is to distinguish a properly handled exception in the notebook from the unexpected ones. We do it actually for our own convenience, because we don't want this type of exceptions to appear in Sentry.
OK, now I see what you mean.

[dsavchenko]

Indeed, it was confusing, maybe you can link the example notebook if not done already.

Most example screenshots in this guide are made with the Fermi notebook, and it's referenced in the beginning

[anawas]

This looks good to me.
It's good practice to introduce designated Exception classes. This allows you to communicate errors more clearly than simply throwing a general excpetion (ie e.g. RuntimeError).

[volodymyrss]

This looks good to me. It's good practice to introduce designated Exception classes. This allows you to communicate errors more clearly than simply throwing a general excpetion (ie e.g. RuntimeError).

Thanks for reviewing! Does the text of the doc look comprehensive too, from a user point of view?

[anawas]

Thanks for reviewing! Does the text of the doc look comprehensive too, from a user point of view?

Yes, the text is clear. It explains how you should handle errors. It is a good reminder to those who heard about this already. However, some users may not be familiar with the concept of classes in Python. Because you can write good code without this concept. But I would not care. You do not need to do it. The code will run fine even if you do not use classes.

[dsavchenko]

Should we merge?

[volodymyrss]

Ok, I think that'd be enough reviews.