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.

Sign up for GitHub

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

Jump to bottom

Document Project better - devices, instrument, descriptors #36

Open

3 tasks

micahwoodard opened this issue Jun 24, 2024 · 0 comments

Open

3 tasks

Document Project better - devices, instrument, descriptors #36

micahwoodard opened this issue Jun 24, 2024 · 0 comments

Assignees

Collaborator

micahwoodard commented Jun 24, 2024 •

edited by waltermwaniki

Loading

Is your feature request related to a problem? Please describe.
Project is poorly document and hard to use because of it.

Describe the solution you'd like

Implement proper documentation for the voxel/devices, voxel/instrument and voxel/descriptors module.

Acceptance Criteria

Add docstring
Add clear comments
Add Readme

micahwoodard self-assigned this

micahwoodard assigned waltermwaniki and unassigned micahwoodard

waltermwaniki changed the title ~~Document Project better~~ Document Project better - devices

waltermwaniki changed the title ~~Document Project better - devices~~ Document Project better - devices, instrument, descriptors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment