OpenChemistry / OpenChemistry/stempy

backend option in reader

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

Nobody has claimed this yet.

Dominant language
C++
Stars
26
Forks
12
Avg merge
1d 2h
Merged PRs (30d)
5

Description

The backend keyword in io.reader() is not checked for incorrect input. If I set:
stempy.io.reader(iFiles,stio.FileVersion.VERSION5, backend='nothing')
the code still runs. Im then unsure which backend is being used.

Need to check backend input for valid options.

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 at the implementation of the Python io.reader() entry point and identify the accepted backend values. Check how the example backend='nothing' is handled, then make invalid backend input clearly fail or report an error and verify the behavior with the reader's existing tests or a focused reproduction.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Bug
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.