Skip to content

Commit 35e8531

Browse files
docs(api/runway): trim package and schema doc comments
Drop the redundant "for non-Go clients" qualifier and the published-contract rationale from the package doc (it lives in the RFC), keeping the doc focused. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent e9242fb commit 35e8531

2 files changed

Lines changed: 6 additions & 10 deletions

File tree

api/runway/messagequeue/merge.go

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,8 @@
1313
// limitations under the License.
1414

1515
// Package messagequeue holds Runway's external message-queue contract: the wire
16-
// payloads for the merge queues Runway owns, alongside the JSON Schema (see the
17-
// embedded *.schema.json) that defines them for non-Go clients. This is a
18-
// published, cross-domain contract — hence its home under api/ — so the payloads
19-
// carry the full data needed to perform a merge attempt rather than opaque
20-
// entity IDs that only Runway could resolve.
16+
// payloads for the merge queues Runway owns, alongside the JSON Schema that
17+
// defines them.
2118
//
2219
// One contract serves two queue pairs because a merge-conflict check is a dry
2320
// run of a merge: Runway applies the same ordered Steps onto the same target

api/runway/messagequeue/schema.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,14 @@ package messagequeue
1616

1717
import _ "embed"
1818

19-
// MergeRequestSchema is the JSON Schema (draft 2020-12) defining the MergeRequest
20-
// wire payload. It is the language-neutral contract a non-Go client validates
21-
// against; the Go MergeRequest type in this package is the matching binding.
19+
// MergeRequestSchema is the JSON Schema (draft 2020-12) for the MergeRequest
20+
// wire payload; the Go MergeRequest type in this package is the matching binding.
2221
//
2322
//go:embed merge_request.schema.json
2423
var MergeRequestSchema []byte
2524

26-
// MergeResultSchema is the JSON Schema (draft 2020-12) defining the MergeResult
27-
// wire payload, the counterpart to MergeRequestSchema for the signal queues.
25+
// MergeResultSchema is the JSON Schema (draft 2020-12) for the MergeResult wire
26+
// payload, the counterpart to MergeRequestSchema for the signal queues.
2827
//
2928
//go:embed merge_result.schema.json
3029
var MergeResultSchema []byte

0 commit comments

Comments
 (0)