From d71a2218405c2a2245369078137005372750adf6 Mon Sep 17 00:00:00 2001 From: Dan Draper Date: Wed, 8 Jul 2026 16:57:21 +1000 Subject: [PATCH] fix(docs): suppress Doxygen auto-linking of `text` in jsonb selector @warning MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Doxygen auto-links the bare word `text` (it collides with a documented symbol) into a cross-reference — even inside inline code. In the jsonb selector operator's @warning, `` `col -> 'sel'::text` `` became `col -> 'sel'text`: a link nested inside inline code. Rendered to Markdown that surfaces as an unbalanced ``, which fails the downstream MDX/docs build (cipherstash/docs was broken by eql-3.0.0-alpha.3's API.md at line 2153, `Expected a closing tag for `). It also drops the `::`, so the cast read as `'sel'text`. Prefix the two `text` occurrences with Doxygen's `%` no-autolink marker (`::%text`, `-> %text`). Verified with doxygen: the nested is gone and `col -> 'sel'::text` now renders as clean, balanced inline code. --- src/v3/jsonb/operators.sql | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/v3/jsonb/operators.sql b/src/v3/jsonb/operators.sql index fa7ec9319..be93e6cd5 100644 --- a/src/v3/jsonb/operators.sql +++ b/src/v3/jsonb/operators.sql @@ -18,8 +18,8 @@ --! index on `eql_v3.eq_term(col -> 'sel')`. --! --! @warning The selector operand MUST carry a known type — a text-typed ---! parameter (`$1`, the Proxy interface) or an explicit cast (`col -> 'sel'::text`). ---! A bare untyped literal (`col -> 'sel'`) resolves to the NATIVE `jsonb -> text` +--! parameter (`$1`, the Proxy interface) or an explicit cast (`col -> 'sel'::%text`). +--! A bare untyped literal (`col -> 'sel'`) resolves to the NATIVE `jsonb -> %text` --! operator and silently returns native jsonb semantics (a root-key lookup, --! typically NULL), NOT this operator: PostgreSQL reduces the `public.json` --! domain to its base type `jsonb` when resolving an unknown-typed RHS, and the