NatLabRockies/reV

Custom reV errors

Open

#486 opened on Dec 7, 2024

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (61 forks)auto 404
documentationenhancementgood first issuep-medium

Repository metrics

Stars
 (139 stars)
PR merge metrics
 (PR metrics pending)

Description

implement custom reV exceptions and raise them throughout the code instead of base exceptions.

This is good practice and allows downstream users of reV to catch reV exceptions explicitly.

Contributor guide

Research direction
Create custom exception classes that inherit from a base reV exception, then replace all raise statements of base exceptions with these custom exceptions. Ensure the exceptions are documented and exported properly.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70