-
Notifications
You must be signed in to change notification settings - Fork 6.8k
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
samples: doc: Added README for RTIO sample #82373
samples: doc: Added README for RTIO sample #82373
Conversation
Hello @michalpiekos, and thank you very much for your first pull request to the Zephyr project! |
d3d3242
to
153264d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for this! some minor typos or grammar corrections
:name: Sensor batch processing | ||
:relevant-api: rtio | ||
|
||
Implements sensor device using RTIO for asynchronuous data processing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a typo + changing wording to follow same style as other samples (https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/templates/sample.tmpl#L5-L6)
Implements sensor device using RTIO for asynchronuous data processing. | |
Implement a sensor device using RTIO for asynchronous data processing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
This sample application demonstrates the use of the :ref:`rtio` library | ||
which is a framework for doing asynchronuous operation chains. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same typo :) + suggested wording improvement
This sample application demonstrates the use of the :ref:`rtio` library | |
which is a framework for doing asynchronuous operation chains. | |
This sample application demonstrates the use of the :ref:`rtio` framework for | |
doing asynchronuous operation chains. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
When running the output on the console shows the operations of | ||
submitting for, consuming and processing the sensor data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When running the output on the console shows the operations of | |
submitting for, consuming and processing the sensor data. | |
When running, the output on the console shows the operations of | |
submitting for, consuming, and processing the sensor data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
samples/subsys/rtio/rtio.rst
Outdated
@@ -0,0 +1,5 @@ | |||
.. zephyr:code-sample-category:: rtio | |||
:name: Real Time I/O |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:name: Real Time I/O | |
:name: Real Time I/O (RTIO) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
Added README.rst for sensor_batch_processing sample. Added rtio.rst listing samples from RTIO subsystem. Signed-off-by: Michal Piekos <[email protected]>
153264d
to
723f678
Compare
Hi @michalpiekos! To celebrate this milestone and showcase your contribution, we'd love to award you the Zephyr Technical Contributor badge. If you're interested, please claim your badge by filling out this form: Claim Your Zephyr Badge. Thank you for your valuable input, and we look forward to seeing more of your contributions in the future! 🪁 |
Added README.rst for sensor_batch_processing sample. Added rtio.rst listing samples from RTIO subsystem.
Helps fix #27805