API guideline fixes#746
Merged
williampMSFT merged 2 commits intoOpenDevicePartnership:v0.2.0from Mar 12, 2026
Merged
Conversation
williampMSFT
requested review from
JamesHuard,
RobertZ2011,
Copilot,
jerrysxie,
kurtjd and
tullom
Contributor
There was a problem hiding this comment.
Pull request overview
This PR makes minor documentation fixes to docs/api-guidelines.md, following up on PR #740 which introduced the uniform service spawning pattern. The fixes address missing lifetime generic parameters in code examples, minor syntax issues, and add a note about task scheduling order when adopting the runner pattern.
Changes:
- Added missing
<'hw>lifetime parameters to type usages in Rust code examples (e.g.,Option<FooInner>→Option<FooInner<'hw>>) - Fixed minor syntax issues: added missing semicolon, removed trailing whitespace, changed "i.e." to "e.g.", added missing newline at EOF
- Added a paragraph warning about event ordering implications when consolidating multiple tasks into a single runner
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
kurtjd
approved these changes
Mar 12, 2026
JamesHuard
approved these changes
Mar 12, 2026
jerrysxie
approved these changes
Mar 12, 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
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.
A few fixes for some stuff that slipped through in #740. Mostly style / example syntax stuff, and added a note about event ordering when adopting the runner pattern