update documentation on the EventsCBGExecutor (backport #6502)#6509
Merged
fujitatomoya merged 1 commit intolyricalfrom Apr 30, 2026
Merged
update documentation on the EventsCBGExecutor (backport #6502)#6509fujitatomoya merged 1 commit intolyricalfrom
fujitatomoya merged 1 commit intolyricalfrom
Conversation
* document CBG Executor Signed-off-by: Skyler Medeiros <skye@polymathrobotics.com> * document thread_num behavior for component containers Signed-off-by: Skyler Medeiros <skye@polymathrobotics.com> * lint Signed-off-by: Skyler Medeiros <skye@polymathrobotics.com> * document fifo characteristics Signed-off-by: Skyler Medeiros <skye@polymathrobotics.com> * the CBG Executor isn't priority based Signed-off-by: Skyler Medeiros <skye@polymathrobotics.com> * add note about overrunning timer Signed-off-by: Skyler Medeiros <skye@polymathrobotics.com> --------- Signed-off-by: Skyler Medeiros <skye@polymathrobotics.com> Co-authored-by: Skyler Medeiros <skye@polymathrobotics.com> (cherry picked from commit a50b91e)
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/25192762949/artifacts/6741662686. To view the resulting site:
|
fujitatomoya
approved these changes
Apr 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds documentation to
About-Executors.rstdetailing how theEventsCBGExecutorworks, how to use it, and some of its performance characteristics.Also updates
About-Composition.rstto document the behavior of the ROS paramthread_num.Did you use Generative AI?
No
Additional Information
This is an automatic backport of pull request #6502 done by [Mergify](https://mergify.com).