docs: 1358 — lay the route-atom docblocks out as caller documentation - #126
Merged
Merged
Conversation
… out as caller documentation One-line summary, a fenced example where one earns its place, then a short line per caller contract. The range behaviour, the non-matching fall-through and the predicate's `Getter` stay; the composition-from-primitives narration goes, and the guide on custom route atoms already carries it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TYNkcK3xGhfZRqkjXqjBu5
…r documentation The last route atom in the same run-on shape. Composition, the reverse/write round-trip and the "consumes no path segments" contract each get their own line. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TYNkcK3xGhfZRqkjXqjBu5
…te docblocks `useRoute` argued for its own name; `Link` described itself as a thin wrapper over `useLink`. Both keep the fact a caller needs — that `useRoute` is `useAtomValue`, and that `useLink` is there for markup that isn't anchor-shaped. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TYNkcK3xGhfZRqkjXqjBu5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
validateRouteAtom,numericRouteAtom,transformRouteAtomandqueryParamRouteAtomeach carried a single run-on paragraph that spliced an example mid-sentence and closed with a justification for the design;useRouteandLinkclosed with the same. They now use the formasyncRouteAtom,navigationGuardAtom,locationAtomandenumRouteAtomalready use: a one-line summary, a fenced example where one earns its place, then a short line per caller-facing constraint.Every genuine gotcha is kept — the inclusive
min/maxrange, the non-matching fall-through, the predicate'sGetter,setterhaving to produce values the parent accepts, and query params consuming no path segments. Cut is the internals and design narration; the "aparamRouteAtomwith atransformRouteAtomon top" explanation already lives where it belongs, in the custom-route-atoms guide.No behaviour change. Build, typecheck, lint and both packages' unit suites pass, and the generated API reference pages render the new examples as code blocks.
🤖 Generated with Claude Code
https://claude.ai/code/session_01TYNkcK3xGhfZRqkjXqjBu5