Skip to content

Commit 0c2f738

Browse files
committed
docs: clear hexdocs link + type-reference warnings for 0.2.0
- README layout table: examples/README.md and docs/testing.md are now absolute GitHub URLs. The relative paths 404 on hexdocs (neither is a doc extra; adding docs/testing.md as an extra would cascade its 6 repo-relative links). - ChunkReader.read_chunk/2 moduledoc: reference read_result as a TYPE (t:read_result/0), not a function. mix docs now emits zero warnings (was 2). Docs-only change; package unchanged.
1 parent 3f6ba5b commit 0c2f738

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,8 +195,8 @@ decoding rows into positional tuples of unknown provenance.
195195
| Directory | Contents |
196196
| --- | --- |
197197
| `lib/` | The Elixir library (hex package `capstan`) — the C1 streaming spine |
198-
| `examples/` | Runnable minimal consumers ([examples/README.md](examples/README.md)) |
199-
| `docker-compose.yml`, `scripts/` | The local MySQL test substrate ([docs/testing.md](docs/testing.md)) |
198+
| `examples/` | Runnable minimal consumers ([examples/README.md](https://github.com/baselabs/capstan/blob/main/examples/README.md)) |
199+
| `docker-compose.yml`, `scripts/` | The local MySQL test substrate ([docs/testing.md](https://github.com/baselabs/capstan/blob/main/docs/testing.md)) |
200200
| `probe/` | The executed protocol viability probe + committed evidence |
201201
| `docs/adr/` | Architecture decision records ([0001](docs/adr/0001-position-and-dedup-model.md)–[0005](docs/adr/0005-initial-snapshot-cursor-gate-brief-lock.md)) |
202202
| `docs/testing.md` | Test environment + how to run the suite |

‎lib/capstan/snapshot/chunk_reader.ex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ defmodule Capstan.Snapshot.ChunkReader do
221221
Reads the next chunk of rows with `pk > cursor` (or from the start when `cursor` is `:start`),
222222
paired with the chunk's exact GTID position `G`, under the pinned brief-lock capture sequence.
223223
224-
Returns a `#{inspect(__MODULE__)}.read_result/0`. The produced `%Capstan.Snapshot.Chunk{}`
224+
Returns a `t:read_result/0`. The produced `%Capstan.Snapshot.Chunk{}`
225225
carries `g` (the exact lower bound), `rows` (the full row images as `column => value` maps),
226226
and `max_pk` (the canonical PK of the last row — the value the cursor advances to). Faults are
227227
classified positionally to `:snapshot_lock_unavailable` / `:snapshot_chunk_read_failed`; a

0 commit comments

Comments
 (0)