Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update all the detectors and ADCore to match ADAravis #754

Open
coretl opened this issue Jan 31, 2025 · 2 comments
Open

Update all the detectors and ADCore to match ADAravis #754

coretl opened this issue Jan 31, 2025 · 2 comments
Labels
good first issue Good for newcomers
Milestone

Comments

@coretl
Copy link
Collaborator

coretl commented Jan 31, 2025

Change class naming, module naming, add docstrings as per the docs in https://blueskyproject.io/ophyd-async/main/how-to/implement-ad-detector.html

Depends on #755

Acceptance Criteria

  • Module named as per docs, e.g. adaravis
  • Class named as per docs, e.g. AravisController, AravisDetector, AravisDriverIO
  • Enums prefixed by module name, e.g. AravisTriggerMode
  • Module has docstring pointing to GitHub repo
  • All IO classes point to the template they describe in the docs, and the HTML docs for it (e.g. https://areadetector.github.io/areaDetector/ADCore/NDPluginOverlay.html)
  • All IO classes updated to use the declarative style
  • Rule "D104" removed from lint.ignore in pyproject.toml
@coretl coretl added the good first issue Good for newcomers label Jan 31, 2025
@coretl coretl added this to the 1.0 milestone Jan 31, 2025
@jwlodek
Copy link
Member

jwlodek commented Jan 31, 2025

All IO classes updated to use the declarative style

Is there a specific reason for going with this over the procedural for these I/O classes?

@coretl
Copy link
Collaborator Author

coretl commented Jan 31, 2025

All IO classes updated to use the declarative style

Is there a specific reason for going with this over the procedural for these I/O classes?

2 reasons:

  • It's shorter
  • It makes it easier to support PVI when we put that in areaDetector

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants