Skip to content

docs: disambiguate coordinator shutdown-state link - #156

Merged
RCmerci merged 1 commit into
mainfrom
codex/shutdown-odoc-reference-20261107
Nov 9, 2026
Merged

RCmerci merged 1 commit into
mainfrom
codex/shutdown-odoc-reference-20261107

Conversation

@RCmerci

@RCmerci RCmerci commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Qualify the coordinator's TLDR reference as {!val-shutdown_state}. The module exports both a type and a function named shutdown_state; this paragraph refers to the function that reads the current shutdown status.

Only the odoc reference changes. No declarations, runtime behavior, or tests are changed.

Validation

Validated source tree a310897cff1f61f3adffece6c490c15b20b34af6:

  • Ran the normal project command dune build @doc in the existing logseq-journal-lui switch. It exited 0 with no output after the fix.
  • Before the fix, the same documentation target reported the ambiguous shutdown_state reference. That warning is absent after the change.
  • Inspected the generated Worker_pure_coordinator/index.html: the TLDR link is href="#val-shutdown_state", and the target is the function declaration val shutdown_state : view -> shutdown_state.
  • ocamlc -i output is identical before and after the change, confirming that exported declarations are unchanged.
  • git diff --check passed. No documentation tests were added.

Three other ambiguous-reference warnings seen in the initial documentation build (state, transition, and availability in Sync specifications) are outside this one-reference fix. The six existing spec-dev-tool check --all decision-document failures also remain unchanged, with output identical to the base.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-07T13:51:35.153756Z 167eccb PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@RCmerci
RCmerci merged commit 6c03085 into main Nov 9, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant