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

Write developer documentation for core hardware code #366

Closed
alexdewar opened this issue Oct 27, 2023 · 0 comments · Fixed by #379
Closed

Write developer documentation for core hardware code #366

alexdewar opened this issue Oct 27, 2023 · 0 comments · Fixed by #379
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@alexdewar
Copy link
Collaborator

alexdewar commented Oct 27, 2023

The core hardware module is already somewhat complicated, but since #336 it has become more so (albeit a bit cleaner!).

As this is potentially a barrier to contributing, the developer documentation for the hardware code should be improved. This could be done either with longer module docstrings or with separate markdown files (or both).

It should include:

  • Explaining concepts like device base type and device type
  • Explaining how to make a new plugin (including making new base types and regular device types)
  • Better API documentation for the current base types
  • Descriptions of the pubsub messages that are used
  • A better module description for data_file_writer.py (possibly, depending on whether we're going to refactor it or not)
@alexdewar alexdewar self-assigned this Oct 27, 2023
@alexdewar alexdewar added the documentation Improvements or additions to documentation label Oct 27, 2023
alexdewar added a commit that referenced this issue Nov 1, 2023
alexdewar added a commit that referenced this issue Nov 23, 2023
alexdewar added a commit that referenced this issue Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant