DiamondLightSource / DiamondLightSource/mx-bluesky

Confusing exception name: WarningError

Open
#1,394 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
4
Forks
5
Avg merge
1d 30m
Merged PRs (30d)
2

Description

In https://github.com/DiamondLightSource/mx-bluesky/issues/1385, exceptions such as `WarningException` were renamed to `WarningError` to comply with pep8 naming conventions, where all exceptions should end in `Error`. This is confusing as this type of exception, and any that inherit from it, do not cause the program to crash, but for the pin to be skipped. Having something called `WarningError` is confusing and should be changed.

An option would be to use the [warnings module](https://docs.python.org/3/library/warnings.html#module-warnings) and avoid inheriting from `Exception`, which would relax the naming rule.

## Acceptance Criteria
- `WarningError` and its children are renamed to something sensible
- pep8 conventions are adhered to

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.