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

Next steps on trigemu documentation #17

Open
jcfreeman2 opened this issue Apr 30, 2021 · 0 comments
Open

Next steps on trigemu documentation #17

jcfreeman2 opened this issue Apr 30, 2021 · 0 comments

Comments

@jcfreeman2
Copy link
Contributor

Right now the documentation is a single sentence in README.md: "Trigger decision emulator for January 2020 readout application tests". This may be enough assuming there are no plans for further use than what's already been done. Otherwise, it's a matter of determining what users would want to know, which I imagine would primarily be a description of the TriggerDecisionEmulator and FakeTimeSyncSource DAQ modules. This in turn may be as simple as cut-and-pasting the documentation at the top of TriggerDecisionEmulator.hpp into README.md (*) and adding a sentence or two about FakeTimeSyncSource

(*) Normally I'd have concerns about straightforwardly cut-and-pasting a comment from a source file into official documentation because they could drift out of sync, but I imagine there won't be much further development of this code in this package

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

No branches or pull requests

1 participant