docs(message): document Input/InputMapping public API with a doctest - #2848
Merged
trunk-io[bot] merged 1 commit intoJul 28, 2026
Merged
Conversation
`dora-message`'s most user-facing config types — the `Input` struct fields (`mapping`, `queue_size`, `input_timeout`, `queue_policy`), the `InputMapping` variants, and `UserInputMapping`'s fields — carried no doc comments, unlike the well-documented `NodeRunConfig` right above them. These map directly onto the `inputs:` YAML surface users author. Add doc comments to those items and a compile-checked doctest on `InputMapping` demonstrating the `FromStr` <-> `Display` round-trip (`camera/image`, `dora/timer/millis/100`, and the missing-separator error case), so the documented wire format stays in sync with the code. Docs-only; no behavior change. Validation: `cargo test -p dora-message --doc` (runs the new doctest), `cargo clippy`, and `cargo fmt --check` pass. This change was generated by Claude (Claude Code), an AI assistant. It is machine-generated and should be reviewed carefully before merging. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01D2eu6P1CvTvoKdK9fK3ZSd
Contributor
|
😎 Merged successfully - details. |
Collaborator
Author
No issues found. Docs-only, no behavior change. The doctest is a real round-trip check rather than a trivial assertion: Generated by Claude Code |
phil-opp
marked this pull request as ready for review
July 28, 2026 11:09
trunk-io
Bot
added
trunk-not-ready
trunk-queued
trunk-testing
trunk-tests-passed
and removed
trunk-not-ready
trunk-queued
trunk-testing
labels
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.
Issue
dora-message's most user-facing config types carried no doc comments, unlike the well-documentedNodeRunConfigright above them:Inputstruct fields (mapping,queue_size,input_timeout,queue_policy)InputMappingvariants (Timer,User)UserInputMappingfields (source,output)These map directly onto the
inputs:YAML surface users author.Fix
Add doc comments to those items, plus a compile-checked doctest on
InputMappingdemonstrating theFromStr↔Displayround-trip (camera/image,dora/timer/millis/100, and the missing-separator error case), so the documented wire format stays in sync with the code.Docs-only; no behavior change.
Validation
cargo test -p dora-message --docruns the new doctest and passes.cargo clippy ... -D warningsandcargo fmt --all --checkpass.🤖 Generated with Claude Code
https://claude.ai/code/session_01D2eu6P1CvTvoKdK9fK3ZSd
Generated by Claude Code