docs: add notes on adoption section to README #29
+8
−0
Conversation
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
Document potential concurrency issues when migrating from SingleThreadedExecutor and considerations for real-time scheduling policies (SCHED_FIFO, SCHED_DEADLINE).
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new "Notes on Adoption" section to the README that documents important considerations when migrating to CallbackIsolatedExecutor, particularly regarding concurrency and real-time scheduling policies.
Changes:
- Added warning about potential concurrency bugs when replacing SingleThreadedExecutor
- Documented considerations for real-time scheduling policies (SCHED_FIFO, SCHED_DEADLINE)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
atsushi421
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Add "Notes on Adoption" section to README documenting important considerations when migrating to CallbackIsolatedExecutor:
Related links
N/A
How was this PR tested?
Verified README renders correctly on GitHub.
Notes for reviewers
Documentation-only change. No code modifications.