Skip to content

added doc comments to builder properties where their were missing#2234

Merged
OlivierHecart merged 19 commits intomainfrom
doc_corrections
Mar 18, 2026
Merged

added doc comments to builder properties where their were missing#2234
OlivierHecart merged 19 commits intomainfrom
doc_corrections

Conversation

@milyin
Copy link
Contributor

@milyin milyin commented Oct 29, 2025

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:

  • Accuracy verified - Technical details are correct
  • Examples tested - Code examples actually work
  • Links valid - All links work and point to correct versions
  • Grammar/spelling - Text is clear and well-written
  • Formatting correct - Markdown/formatting renders properly
  • Up-to-date - Reflects current codebase state

Suggestion: Have someone unfamiliar with the feature review for clarity.

Instructions:

  1. Check off items as you complete them (change - [ ] to - [x])
  2. The PR checklist CI will verify these are completed

This checklist updates automatically when labels change, but preserves your checked boxes.

@milyin milyin added the documentation Improvements or additions to documentation label Oct 29, 2025
@milyin milyin changed the title added doc comments to builder properties where was missed added doc comments to builder properties where their were missing Oct 29, 2025
@codecov
Copy link

codecov bot commented Oct 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.60%. Comparing base (44844ba) to head (57437bf).
⚠️ Report is 4 commits behind head on main.
✅ All tests successful. No failed tests found.

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.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Sample accessors 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.

milyin and others added 12 commits March 16, 2026 18:03
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>
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>
@OlivierHecart OlivierHecart merged commit 58c41b5 into main Mar 18, 2026
50 checks passed
@OlivierHecart OlivierHecart deleted the doc_corrections branch March 18, 2026 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review rustdoc of AdvancedPublicationBuilder::attachment

3 participants