Skip to content

Commit 5360d7d

Browse files
adriangbclaude
andcommitted
Fix broken intra-doc links in proto_encode/proto_decode
Module-level doc comments referenced items inside the modules without qualifying them, so cargo doc with `-D warnings` (CI default) failed with `unresolved link` warnings. Qualify the links with the `proto_encode::` / `proto_decode::` module prefix. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 31465ae commit 5360d7d

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,4 @@ profile.json.gz
8181

8282
# Claude Code personal settings
8383
.claude/settings.local.json
84+
.claude/

datafusion/physical-expr-common/src/physical_expr.rs

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -478,11 +478,11 @@ pub trait PhysicalExpr: Any + Send + Sync + Display + Debug + DynEq + DynHash {
478478

479479
/// Encode-side context for [`PhysicalExpr::to_proto`].
480480
///
481-
/// Expression authors only ever see [`PhysicalExprEncodeCtx`]: a concrete
482-
/// struct with stable methods. Internally it dispatches to a
483-
/// [`PhysicalExprEncode`] implementor that lives in `datafusion-proto`,
484-
/// which is what lets `physical-expr-common` stay free of `datafusion-proto`
485-
/// as a dep.
481+
/// Expression authors only ever see [`proto_encode::PhysicalExprEncodeCtx`]:
482+
/// a concrete struct with stable methods. Internally it dispatches to a
483+
/// [`proto_encode::PhysicalExprEncode`] implementor that lives in
484+
/// `datafusion-proto`, which is what lets `physical-expr-common` stay free
485+
/// of `datafusion-proto` as a dep.
486486
///
487487
/// More specialized helpers (e.g. encoding UDFs/UDAFs/UDWFs through the
488488
/// extension codec) can be added to the context as expressions migrate;
@@ -536,8 +536,9 @@ pub mod proto_encode {
536536
/// Decode-side counterpart to [`proto_encode`].
537537
///
538538
/// Expression authors implement an associated `try_from_proto` on their
539-
/// concrete type and receive a [`PhysicalExprDecodeCtx`]; the central match
540-
/// in `datafusion-proto` dispatches `ExprType` variants to those constructors.
539+
/// concrete type and receive a [`proto_decode::PhysicalExprDecodeCtx`]; the
540+
/// central match in `datafusion-proto` dispatches `ExprType` variants to
541+
/// those constructors.
541542
///
542543
/// As with the encode side, the public surface is a struct (not a `&dyn`
543544
/// trait) so future fields/helpers (registries for third-party expressions,

0 commit comments

Comments
 (0)