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

samples: doc: Added README for RTIO sample #82373

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

michalpiekos
Copy link
Contributor

Added README.rst for sensor_batch_processing sample. Added rtio.rst listing samples from RTIO subsystem.
Helps fix #27805

Copy link

github-actions bot commented Dec 1, 2024

Hello @michalpiekos, and thank you very much for your first pull request to the Zephyr project!
Our Continuous Integration pipeline will execute a series of checks on your Pull Request commit messages and code, and you are expected to address any failures by updating the PR. Please take a look at our commit message guidelines to find out how to format your commit messages, and at our contribution workflow to understand how to update your Pull Request. If you haven't already, please make sure to review the project's Contributor Expectations and update (by amending and force-pushing the commits) your pull request if necessary.
If you are stuck or need help please join us on Discord and ask your question there. Additionally, you can escalate the review when applicable. 😊

Copy link
Collaborator

@kartben kartben left a 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.
Copy link
Collaborator

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)

Suggested change
Implements sensor device using RTIO for asynchronuous data processing.
Implement a sensor device using RTIO for asynchronous data processing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Comment on lines 10 to 11
This sample application demonstrates the use of the :ref:`rtio` library
which is a framework for doing asynchronuous operation chains.
Copy link
Collaborator

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

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Comment on lines 34 to 35
When running the output on the console shows the operations of
submitting for, consuming and processing the sensor data.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@@ -0,0 +1,5 @@
.. zephyr:code-sample-category:: rtio
:name: Real Time I/O
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:name: Real Time I/O
:name: Real Time I/O (RTIO)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@kartben kartben assigned teburd and unassigned kartben Dec 11, 2024
Added README.rst for sensor_batch_processing sample.
Added rtio.rst listing samples from RTIO subsystem.

Signed-off-by: Michal Piekos <[email protected]>
@kartben kartben merged commit 3b56358 into zephyrproject-rtos:main Dec 16, 2024
17 checks passed
Copy link

Hi @michalpiekos!
Congratulations on getting your very first Zephyr pull request merged 🎉🥳. This is a fantastic achievement, and we're thrilled to have you as part of our community!

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! 🪁

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

Successfully merging this pull request may close these issues.

samples without README
4 participants