POSYDON-code / POSYDON-code/POSYDON

Add better checks on assumed input types/values to all functions

Open
#462 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue help wanted
Dominant language
Python
Stars
45
Forks
37
Avg merge
8d 20h
Merged PRs (30d)
5

Description

We have a lot of functions, which work currently with assumptions either only written in the doc-strings or even nowhere mentioned. All this can produce unforeseen runtime errors at any parts of the code.
A more specific example in the case of None type objects is already given in issue #236 .
Another common case are floats or integers to be of the correct type or range.

Contributor guide

No contributing guide indexed for this repository

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

Start by reviewing issue #236 and the project's Python functions and docstrings to identify assumptions about None values, integer or float types, and valid ranges. Define the scope of checks before changing code; done means the affected functions reject invalid inputs consistently and the relevant runtime-error cases are covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
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.