Repository navigation
docs: disambiguate coordinator shutdown-state link - #156
Merged
Merged
Conversation
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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
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.
Summary
Qualify the coordinator's TLDR reference as
{!val-shutdown_state}. The module exports both a type and a function namedshutdown_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:dune build @docin the existinglogseq-journal-luiswitch. It exited 0 with no output after the fix.shutdown_statereference. That warning is absent after the change.Worker_pure_coordinator/index.html: the TLDR link ishref="#val-shutdown_state", and the target is the function declarationval shutdown_state : view -> shutdown_state.ocamlc -ioutput is identical before and after the change, confirming that exported declarations are unchanged.git diff --checkpassed. No documentation tests were added.Three other ambiguous-reference warnings seen in the initial documentation build (
state,transition, andavailabilityin Sync specifications) are outside this one-reference fix. The six existingspec-dev-tool check --alldecision-document failures also remain unchanged, with output identical to the base.