[PR #2909] [MERGED] docs: fix errors in line and document comments #3417

New issue

Closed

opened 2026-03-16 11:42:33 +03:00 by kerem · 0 comments

kerem commented

2026-03-16 11:42:33 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hickory-dns/hickory-dns/pull/2909
Author: @Aden-Q
Created: 4/5/2025
Status: ✅ Merged
Merged: 4/7/2025
Merged by: @djc

Base: main ← Head: main

📝 Commits (2)

1cd45d1 docs: fix errors in cargo docs and comments
710dc02 docs: order for arg document

📊 Changes

4 files changed (+21 additions, -40 deletions)

View changed files

📝 crates/client/src/client/client.rs (+1 -1)
📝 crates/client/src/lib.rs (+1 -1)
📝 crates/proto/src/op/update_message.rs (+18 -37)
📝 crates/proto/src/xfer/dns_multiplexer.rs (+1 -1)

📄 Description

This patch fixes some errors in cargo docs and inline comments.

missing arg document use_edns
SyncClient not used anymore
delete_by_rdata: this method doesn't have any prerequisites. Also according to RFC 2136 and the implementation here. The document shouldn't include the prerequisites section, as it's not used. It could be misleading
fix some typos

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hickory-dns/hickory-dns/pull/2909 **Author:** [@Aden-Q](https://github.com/Aden-Q) **Created:** 4/5/2025 **Status:** ✅ Merged **Merged:** 4/7/2025 **Merged by:** [@djc](https://github.com/djc) **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (2) - [`1cd45d1`](https://github.com/hickory-dns/hickory-dns/commit/1cd45d13ae4a0994053ee562928450fc3790a69c) docs: fix errors in cargo docs and comments - [`710dc02`](https://github.com/hickory-dns/hickory-dns/commit/710dc02f43a7e9cf25da12d9ad7e153a8662c74f) docs: order for arg document ### 📊 Changes **4 files changed** (+21 additions, -40 deletions) <details> <summary>View changed files</summary> 📝 `crates/client/src/client/client.rs` (+1 -1) 📝 `crates/client/src/lib.rs` (+1 -1) 📝 `crates/proto/src/op/update_message.rs` (+18 -37) 📝 `crates/proto/src/xfer/dns_multiplexer.rs` (+1 -1) </details> ### 📄 Description This patch fixes some errors in cargo docs and inline comments. 1. missing arg document `use_edns` 2. SyncClient not used anymore 3. `delete_by_rdata`: this method doesn't have any prerequisites. Also according to RFC 2136 and the implementation here. The document shouldn't include the prerequisites section, as it's not used. It could be misleading 4. fix some typos --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>