added doc comments to builder properties where their were missing#2234
added doc comments to builder properties where their were missing#2234OlivierHecart merged 19 commits intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2234 +/- ##
==========================================
+ Coverage 72.46% 72.60% +0.13%
==========================================
Files 390 390
Lines 63360 63366 +6
==========================================
+ Hits 45911 46004 +93
+ Misses 17449 17362 -87 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Pull request overview
This PR updates rustdoc comments across Zenoh’s Rust API/builders to improve clarity and correct/avoid misleading documentation around QoS and attachments (including the concern raised in #2235).
Changes:
- Refines rustdoc for QoS-related getters/setters (priority, congestion control, express) across multiple builders.
- Updates attachment/source_info/timestamp builder docs and
Sampleaccessors to be less misleading. - Adds/adjusts high-level docs for
Publisher.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| zenoh/src/api/sample.rs | Updates rustdoc for QoS getters and attachment accessors on Sample. |
| zenoh/src/api/querier.rs | Tweaks rustdoc for QoS getters on Querier. |
| zenoh/src/api/publisher.rs | Adds clarifying rustdoc on how Publisher is declared. |
| zenoh/src/api/builders/sample.rs | Adds/updates rustdoc on builder traits and implementations (QoS/timestamp/source_info/attachment/encoding). |
| zenoh/src/api/builders/reply.rs | Adds/updates rustdoc for reply builder timestamp/attachment/source_info/encoding/QoS. |
| zenoh/src/api/builders/query.rs | Adds/updates rustdoc for SessionGetBuilder sample/QoS/encoding-related builder methods. |
| zenoh/src/api/builders/querier.rs | Adds/updates rustdoc for querier builders (QoS + get builder sample/encoding methods). |
| zenoh/src/api/builders/publisher.rs | Minor rustdoc tweak for priority setter wording. |
| zenoh-ext/src/advanced_publisher.rs | Adds/updates rustdoc for advanced publisher/publication builders (encoding/QoS/sample/timestamp). |
| zenoh-ext/src/advanced_cache.rs | Adds/updates rustdoc for RepliesConfig QoS builder methods. |
💡 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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Minor documentation updates
Fixes #2235
🏷️ Label-Based Checklist
Based on the labels applied to this PR, please complete these additional requirements:
Labels:
documentation📚 Documentation Update Requirements
Since this PR updates documentation:
Suggestion: Have someone unfamiliar with the feature review for clarity.
Instructions:
- [ ]to- [x])This checklist updates automatically when labels change, but preserves your checked boxes.