scikit-hep / scikit-hep/pyhf

Error message cleaning: Improve error messages around bare raises

Open
#1,663 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

refactor
Dominant language
Python
Stars
303
Forks
102
Avg merge
12h 39m
Merged PRs (30d)
17

Description

This should get a better error message, but let's make this a whole separate Issue where we do some cleaning.

Try to make error messages less opaque by giving some descriptive error messages anytime something is raised

Originally posted by @matthewfeickert in https://github.com/scikit-hep/pyhf/pull/1639#r734727463

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified in the issue. Start by auditing the Python code for bare raises and opaque error messages, then define a scoped set of changes and tests that demonstrate descriptive messages for the selected cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.