You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iggy.apache.org by kr...@apache.org on 2026/10/14 05:00:51 UTC

(iggy) branch kafka-gateway-perf updated: fix(gateways): stop public docs linking to private items

This is an automated email from the ASF dual-hosted git repository.

krishvishal pushed a commit to branch kafka-gateway-perf
in repository https://gitbox.apache.org/repos/asf/iggy.git


The following commit(s) were added to refs/heads/kafka-gateway-perf by this push:
     new 29618a5ba fix(gateways): stop public docs linking to private items
29618a5ba is described below

commit 29618a5ba5758ba52e3acaf2e10d70d2e95453b3
Author: Krishna Vishal <kr...@gmail.com>
AuthorDate: Wed Oct 14 10:22:41 2026 +0530

    fix(gateways): stop public docs linking to private items
    
    The CI doc build denies warnings, and the docs of ProducerIdAllocator
    and record_slots linked to private items. Name them in code spans.
---
 gateways/kafka/src/protocol/handlers/init_producer_id.rs | 2 +-
 gateways/kafka/src/records.rs                            | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/gateways/kafka/src/protocol/handlers/init_producer_id.rs b/gateways/kafka/src/protocol/handlers/init_producer_id.rs
index 98458b47c..4f62d754a 100644
--- a/gateways/kafka/src/protocol/handlers/init_producer_id.rs
+++ b/gateways/kafka/src/protocol/handlers/init_producer_id.rs
@@ -67,7 +67,7 @@ const PRODUCER_EPOCH: i16 = 0;
 /// allocation per millisecond of its uptime, the clock stepped back across the restart, or the
 /// clock reads before the Unix epoch and seeds 0. Nothing is persisted.
 ///
-/// Produce keys an Iggy session on the id, and only on an id of this run ([`Self::issued`]). A
+/// Produce keys an Iggy session on the id, and only on an id of this run (`issued`). A
 /// replayed pair then makes two producers share a session, and nothing more. Before deduplication
 /// reads the id, the allocator has to persist a high-water mark or bump the epoch on every start.
 #[derive(Debug)]
diff --git a/gateways/kafka/src/records.rs b/gateways/kafka/src/records.rs
index e4054f804..586ded2cc 100644
--- a/gateways/kafka/src/records.rs
+++ b/gateways/kafka/src/records.rs
@@ -882,7 +882,7 @@ pub fn declared_records(blob: &[u8]) -> Option<usize> {
 }
 
 /// Record slots the first batch in `blob` takes to decode, when it is not compressed: one per
-/// declared record, plus its headers as [`scan_records`] charges them. Stops at `most`.
+/// declared record, plus its headers as `scan_records` charges them. Stops at `most`.
 ///
 /// Counts the records it can walk. The decode refuses a batch that does not walk, so that batch
 /// holds nothing.