Skip to content

Commit 9328934

Browse files
committed
docs(mongo-query-builder): fix README ADR 180 link path
The README lives 4 directories deep under the repo root, so its link to ADR 180 needs four `..`, not five. The extra `..` was causing the link to point outside the repository tree and miss `docs/` entirely. Addresses PR #361 review comment from CodeRabbit (discussion_r3118221548).
1 parent a5381c2 commit 9328934

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

  • packages/2-mongo-family/5-query-builders/query-builder

packages/2-mongo-family/5-query-builders/query-builder/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ Stage callbacks receive a `FieldAccessor<Shape, Nested>` (typically named `f`):
9292

9393
The callable form is disabled (at the type level) downstream of replacement stages (`project`, `group`, `replaceRoot`, …) that erase the nested structure; additive stages (`match`, `sort`, `addFields`, `lookup`, …) preserve it.
9494

95-
- **Escape hatch**`f.raw("path")`: sidesteps path validation and returns a `LeafExpression<DocField>` carrying the verbatim string path. Use when the path is intentionally outside the typed model — the canonical case is **migration authoring**, where a backfill writes to a field that is not yet in the pre-migration contract (see the retail-store example's `backfill-product-status` migration). `f.raw` offers the full leaf operator surface (`set`, `exists`, `inc`, `push`, …) and no IDE autocomplete. Callers can narrow the return via an explicit generic: `f.raw<StringField>("status").set("active")`.
95+
- **Escape hatch**`f.rawPath("path")`: sidesteps path validation and returns a `LeafExpression<DocField>` carrying the verbatim string path. Use when the path is intentionally outside the typed model — the canonical case is **migration authoring**, where a backfill writes to a field that is not yet in the pre-migration contract (see the retail-store example's `backfill-product-status` migration). `f.rawPath` offers the full leaf operator surface (`set`, `exists`, `inc`, `push`, …) and no IDE autocomplete. Callers can narrow the return via an explicit generic: `f.rawPath<StringField>("status").set("active")`. The method is named `rawPath` rather than `raw` so a user model with a legitimate top-level `raw` field still resolves `f.raw` to the field expression.
9696

97-
See [ADR 180 — Dot-path field accessor](../../../../../docs/architecture%20docs/adrs/ADR%20180%20-%20Dot-path%20field%20accessor.md) for the design rationale.
97+
See [ADR 180 — Dot-path field accessor](../../../../docs/architecture%20docs/adrs/ADR%20180%20-%20Dot-path%20field%20accessor.md) for the design rationale.
9898

9999
## Update operators
100100

0 commit comments

Comments
 (0)