Skip to main content

Module documentation_request

Module documentation_request 

Source
Expand description

#847: bynk/documentationModel — the documentation-view custom LSP request.

The second custom request in this server (after #846’s bynk/sequenceModel), and the same posture: no workspace/*/refresh nudge exists for a custom method and none is needed — Tier 1 is on-demand, the client re-issues the request each time “Bynk: Show Documentation” fires (Decision D).

Unlike bynk/sequenceModel, the request carries no cursor position: a documentation page is the whole file’s declarations (Decision A, file-scoped), so the params are a bare TextDocumentIdentifier. The wire shape is a plain serde mirror of bynk_ide::documentation::DocModel, each Span lowered to an LSP Range against the committed snapshot text the caller already holds — the same convention sequence_request/SerKey use.

Structs§

DocumentationModelParams
The bynk/documentationModel request payload. A bare text-document identifier — no cursor position (the page is the whole file, Decision A).
WireDocEntry
WireDocModel

Functions§

documentation_model_at
Build the documentation model for text (a committed snapshot). None for a unit with no doc page — a suite, or a file with no recognisable header.
to_wire