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

Document device features #755

Closed
Tracked by #783
rytilahti opened this issue Feb 15, 2024 · 3 comments
Closed
Tracked by #783

Document device features #755

rytilahti opened this issue Feb 15, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@rytilahti
Copy link
Member

Update documentation (design.rst) concerning the newly added device features.

@sdb9696
Copy link
Collaborator

sdb9696 commented May 23, 2024

There's a few ways to do this but I think it would be best if the documentation is embedded in the code somehow. Do we want per feature documentation or just an overview of how a feature works? If it's per feature we could either add to the modules that create the features or inline it with each feature in the list of feature ids here: #926.

@rytilahti
Copy link
Member Author

Just a quick, general overview of how modules & features work in the separate doc is enough, the details (where needed) would be inside docstrings.

Basically just discussing how the interfaces are designed and expected to be used.

@sdb9696
Copy link
Collaborator

sdb9696 commented Jun 21, 2024

Done in #968

@sdb9696 sdb9696 closed this as completed Jun 21, 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

No branches or pull requests

2 participants