[PR #1897] [MERGED] docs: fix truncated rustdoc TODO on LowerName. #2684

New issue

Closed

opened 2026-03-16 11:02:29 +03:00 by kerem · 0 comments

kerem commented

2026-03-16 11:02:29 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hickory-dns/hickory-dns/pull/1897
Author: @cpu
Created: 2/27/2023
Status: ✅ Merged
Merged: 2/28/2023
Merged by: @djc

Base: main ← Head: cpu-lower_name-rustdoc-fix

📝 Commits (1)

47c1e2a docs: fix truncated rustdoc TODO on LowerName.

📊 Changes

1 file changed (+1 additions, -0 deletions)

View changed files

📝 crates/proto/src/rr/lower_name.rs (+1 -0)

📄 Description

👋 I noticed the Rustdoc for the client LowerName type was confusing. In total it says "them should be through references. As a workaround the Strings are all Rc as well as the array" 🤔 I traced down what happened with some Git spelunking.

In ec059f3 the LowerName type was introduced along with two TODO rustdoc comments, one for refactoring to use references into a global intern space and one for supporting non-utf8 encodings.

In 55477de, the UTF-8 TODO was resolved and Punycode/IDNA support was added. As an unintended side-effect, it looks like this commit also truncated the first TODO, leaving a dangling piece of text.

This commit restores the missing piece of text about using references into a global intern space in the future.

_{🔄 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/1897 **Author:** [@cpu](https://github.com/cpu) **Created:** 2/27/2023 **Status:** ✅ Merged **Merged:** 2/28/2023 **Merged by:** [@djc](https://github.com/djc) **Base:** `main` ← **Head:** `cpu-lower_name-rustdoc-fix` --- ### 📝 Commits (1) - [`47c1e2a`](https://github.com/hickory-dns/hickory-dns/commit/47c1e2ada4e029d4cfe5293ead64267d5295f552) docs: fix truncated rustdoc TODO on LowerName. ### 📊 Changes **1 file changed** (+1 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `crates/proto/src/rr/lower_name.rs` (+1 -0) </details> ### 📄 Description :wave: I noticed [the Rustdoc for the client `LowerName` type](https://docs.rs/trust-dns-client/latest/trust_dns_client/rr/struct.LowerName.html) was confusing. In total it says "them should be through references. As a workaround the Strings are all Rc as well as the array" :thinking: I traced down what happened with some Git spelunking. In ec059f3 the `LowerName` type was introduced along with [two TODO rustdoc comments](https://github.com/bluejekyll/trust-dns/commit/ec059f38d0a3c46b4d8d448ddd36f9b1a42c287f#diff-5530b6a4d1c8c113a81cba0a5b94a78fe849b53bda8ec027ea6c55bdeb30640fR24-R28), one for refactoring to use references into a global intern space and one for supporting non-utf8 encodings. In 55477de, the UTF-8 TODO was resolved and Punycode/IDNA support was added. As an unintended side-effect, it looks like this commit also truncated the first TODO, leaving a dangling piece of text. This commit restores the missing piece of text about using references into a global intern space in the future. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>