DiamondLightSource/dodal

Check and fix device arguments

Open

#1,024 opened on Jan 27, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (12 forks)auto 404
good first issue

Repository metrics

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

Description

From #1021

the default behaviour of @device_factory is that the name of the device is the name of the factory

Turns out that eg the zebra device has name as a required argument, coming before prefix. We should go through all devices and check that prefix is always before name, and that name is optional.

Acceptance Criteria

  • Specific criteria that will be used to judge if the issue is fixed

Contributor guide

Research direction
Examine each device factory to ensure 'prefix' argument precedes 'name' and that 'name' is optional. Start by looking at the zebra device as an example.
Tech stack
python
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Fresh
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.
60