-
Notifications
You must be signed in to change notification settings - Fork 6
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
Update docs to clarify what data is returned in a frame from the camera #10
Labels
documentation
Improvements or additions to documentation
Comments
greenbreakfast
added
the
documentation
Improvements or additions to documentation
label
Nov 28, 2020
@greenbreakfast should we do this in the separate common module, or just simply adding in the existing camera module docs (adding description into the readFrame method of Camera)? |
@greenbreakfast could you please have a look if the docs reads better? specifically the Camera and the Frame in common module. |
@vsemi This is a good start. A few more suggestions:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When looking at the documentation right now, it's hard to figure out what data is returned when reading a frame from the camera. This makes it really hard for users to write their own programs using this library.
With the current documentation, the user must trace through the source code to get some understanding - this is a large barrier to entry. And even then, there's no indication how the frame data is arranged in the members of the Frame object.
The documentation should be updated to:
@vsemi let's brainstorm on how we can improve the documentation to better cover the above topics
The text was updated successfully, but these errors were encountered: