scverse / scverse/spatialdata

Don't use empty `asserts`

Open
#1,019 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
394
Forks
95
Avg merge
4d 3h
Merged PRs (30d)
7

Description

I remember seeing quite a few GitHub issues that are opened because users run into assert statements that just fail but don't educate the user why they were caused. I think we should have an internal policity to not have that and instead raise proper errors. That'd also make triaging issues for us easier.

Will continue to link related issues below:

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 named. Start by reviewing the related spatialdata-plot issue and locating empty assert statements in the project; done means defining the proposed policy and replacing the relevant assertions with errors that explain the cause.

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
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.