-
Notifications
You must be signed in to change notification settings - Fork 25
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
Added more documentation #107
base: main
Are you sure you want to change the base?
Conversation
as there is currently no support for tango, I think I need to mention this somewhere at a top level. Otherwise it gets annoying having to write everywhere that you could do this with a tango layer instead of epics. I'll do this next week. |
ee59874
to
438855d
Compare
Move code samples into epics.demo or similar. Make sure the words make sense. TODO by me. |
@@ -0,0 +1,216 @@ | |||
Create Detectors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I recommend renaming this to Support Various Detectors
and adding a line at the start explaining, for new people, that detectors all have shared functionality but behave in subtly different ways and this article explains how to compose various components in different ways to support different ones. If I were a new starter reading this I'd be wondering why it's so complicated, so I think it would be good to convey that from the start.
A StandardDetector needs two crucial components; a `DetectorControl` object and | ||
a `DetectorWriter`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could allude to the driver here as well?
@callumforrester is any of this worth adding to the current docs after your additions? |
@coretl Will review and get back to you |
No description provided.