DiamondLightSource / DiamondLightSource/dodal

Every device class should have a docstring

Open
#1,360 4 comments 0 reactions 0 assignees View on GitHub
Docsathon documentation
Dominant language
Python
Stars
5
Forks
13
Avg merge
3d 2h
Merged PRs (30d)
10

Description

To aid people in finding other devices that could be useful for them each device should have a docstring explaining what it does. Specifically:
* What a scientist will use it for
* Any unusual logic that the device might need

## Acceptance Criteria
* Every dodal device has a class docstring
* There is a CI step enforcing this

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.