Repository navigation
docs: cite celeris symbols, not line numbers (routing helpers, data stores, performance, deployment, graceful shutdown) - #105
Merged
Conversation
This was referenced Oct 19, 2026
Merged
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
goceleris-docs | dd222f8 | Commit Preview URL Branch Preview URL |
Oct 19 2026, 11:07 AM |
FumingPower3925
force-pushed
the
fix/docscites-polish
branch
from
October 19, 2026 10:16
19a013a to
95bfa70
Compare
FumingPower3925
force-pushed
the
fix/docscites-polish-2
branch
from
October 19, 2026 10:16
a9b4afc to
b63329f
Compare
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 56 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
FumingPower3925
force-pushed
the
fix/docscites-polish-2
branch
2 times, most recently
from
October 19, 2026 10:35
e1d388f to
8167681
Compare
FumingPower3925
marked this pull request as ready for review
October 19, 2026 11:06
…a stores, performance, deployment and graceful shutdown Covers the same mapping as the first batch. deployment.md now says a start that fails before its engine runs releases the handed listener before it returns the error (celeris#747), except ErrAlreadyStarted. Refs #891 item 8 Refs #891 item 10
…rmance point at their own config files Refs #891 item 10
… issue and its fix, and the JSON fast-path citation names Context.JSON
…e Connector citation names WithEngine
FumingPower3925
force-pushed
the
fix/docscites-polish-2
branch
from
October 19, 2026 11:07
10ed9f5 to
dd222f8
Compare
FumingPower3925
marked this pull request as draft
October 19, 2026 11:07
FumingPower3925
marked this pull request as ready for review
October 19, 2026 11:08
Contributor
Author
|
Merging with every required check green (build, coverage, CodeQL, codecov/patch, Workers Builds). The CodeRabbit review is advisory and had not finished. |
30 of 40 tasks
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.
Second batch of the symbol-citation change: routing helpers, data stores, performance, deployment and graceful shutdown. Draft. Stacked on the first batch (#104, the base of this PR); PR 3 is stacked on this one.
#Nin this body means goceleris/celeris#N, except where it says goceleris/docs. The items are the checklist items of goceleris/celeris#891 numbered as in the DOCSSITE PR (items 8 and 10). The checklist issue stays open and its boxes are not ticked here.What changed
celeris/<path>.go(Symbol) in place ofpath.go:N[-M]. That is 148 locators. With PR 1 (165), 313 of the 515 locators are done; 202 remain on 12 pages (PR 3).celeris/server.go:1035-1066, the listener-ownership sentence) now citesceleris/server.go(Server.StartWithListener).celeris/server.go:1148-1166, celeris/server.go:1035-1066) now citesceleris/server.go(InheritListener) andceleris/server.go(Server.StartWithListener), the two names the paragraph uses.resource/config.go:152-161("now elsewhere") is already gone at 7ecb763. docs: shutdown, deployment, getting-started, error-handling and data-stores match v1.6.0 #102 moved that sentence toceleris/internal/resource/config.go:210-224, and152-161appears nowhere under src/content/docs. This batch cites that sentence asConfig.Validate. Evidence: the quoted "ambiguous configuration" error is at internal/resource/config.go:246 on celeris origin/main, insideConfig.Validate(173-253 there). The listener-ownership section was already symbolic at 7ecb763 (prepareWithListeneralready present, no locator), so this batch does not touch it.Handler.Close,NewWithCloser), errors.go:29-31 (ErrAcceptControlNotSupported), internal/engine/engine.go:38-62 (AcceptController), and resource/config.go:210-224 (Config.Validate).ErrAlreadyStartedis the exception: the server is already running and the listener stays with the caller. Checked on celeris origin/main: the doc comment ofStartWithListenersays this, andstart_failure_release_test.go(TestFailedStartClosesTheSuppliedListener) pins it. The sentence links celeris issue #737 and the change PR #747 (see Review round 1: graceful-shutdown.md now links both as well).celeris/and the repository path: data-stores.md (37 bare), performance.md (2), deployment.md (2). Each bare name is resolved from its own sentence, not from the root package: in deployment.md,config.go:10-15isceleris/middleware/healthcheck/config.go(DefaultStartPath) andconfig.go:69-75isceleris/middleware/healthcheck/config.go(FastPathTimeout); in performance.md,config.go:48-55isceleris/middleware/overload/config.go(Thresholds). Bareserver.goandrouter.goin data-stores.md are the root files.scripts/docs-symbol-citations.test.ts). The allowlist drops these five pages. The continuation check now also catches comma lists (x.go:1-2,3-4,x.go:1-2, 3-4) and a range wrapped onto the next line.Special cases handled by hand
middleware/session/config.go:63-66,205-206andmiddleware/cache/config.go:12-13,107-108): comma lists, two symbols each.proxy.go:97-117, 215-226), deployment.md:254 (healthcheck.go:13-16,wrapped onto the next line as163-174) and graceful-shutdown.md:445 (session.go:319,395): two symbols each; the wrapped one is one citation now.Checks run in the first version (head b63329f, tree as a9b4afc; current head under Review round 1)
bun test scripts/docs-symbol-citations.test.tspasses (3 tests). Control, run on the batch before the last two corrections: one`celeris/middleware/proxy/proxy.go:97-117, 215-226`line appended to deployment.md makes the offender and continuation tests fail; restored and passing again.work/verify_all.pyparses each`celeris/<path>.go` (`Sym`, ...)group and checks the path exists on celeris origin/main and each symbol is declared there (a method name matchesType.NameorName). Output in work/verify-all-pr2.log: 323 citations, 0 bad.bun run validate,bun run build,bun run check,bun test, all exit 0 (logs work/ci-*-pr2.log).bun testran 25 tests across 2 files.Review round 1 (head 8167681)
Refs #891 item 8. This branch is rebased onto the new head of #104 (cb88174), which carries the widened ratchet (detector shapes and failing-first evidence are in the body of #104).
jsonSafeValuefor a range that also holdsContext.JSON; it now names both. The five continuation ranges of these pages (205-206,107-108,215-226,163-174,session.go:319,395) were re-resolved at their introducing revisions (work/r1/contranges2.log) and agree with the symbols cited..go:Nlocator now carry theceleris/prefix and the full path:middleware/store/kv.go,middleware/session/session.go,driver/redis/options.go,driver/redis/commands.go,driver/postgres/pool.goand the overloadconfig.go. The ratchet's prefix guard (PR 3) flagsdir/x.goand(x.go). It does not flag a bare backticked file name such as`config.go`, so the claim is that the two shapes it checks are clean, not that every mention is guarded.Checks on head 8167681 (work/r1/):
bun run validate,bun run build,bun run checkandbun testexit 0 (ci-*-pr2-8167681.log; 27 tests across 2 files);verify_all.py342 symbol citations, 0 bad (verify-all-pr2-8167681.log).Neighbours changed in the same paragraphs
StartWithListenerparagraph gets the #747 sentence. The sentence before it (the one about not accepting on the passed listener) is unchanged; the new sentence names the one exception.Server.doPreparein one parenthesis are one citation.Review round 2 (head 10ed9f5)
Refs #891 item 8. Plain merge of #104's head 20380a0 into this branch (no force-push), then:
Counterfor the optional capability interfaces; the sentence covers six interfaces andCounteris the last, so the first named,GetAndDeleter, is cited. data-stores.md:334 now namesConnector.WithEngineas well asNewConnector(the sentence rebinds the Connector withWithEngine, thensql.OpenDB).Checks on head 10ed9f5: validate, build, check, test all exit 0 (logs ci-*-pr2.log in the lane).
Open points (not blocking)
memoryLimitBytes must be >= 0(Config.Validate),ambiguous configuration(Config.Validate),websocket: origin not allowed(New), andengine epoll requires Linux(inside Config.Validate, internal/resource/config.go:229). The 33 with no hit are signatures and code samples, not literals. This is a sample, not a full check of every sentence; the introducing-commit check was done in Review round 1 (see the PR body of docs: cite celeris symbols, not line numbers (configuration, middleware-traffic, websocket) #104).WithDefaults)" in PR 1 and "Shutdown", "Start" in this batch): the path is replaced and the existing name is kept. These are methods on the named type; the verify step matches them by method name.Refs #891 item 8
Refs #891 item 10