docs: fix the three XML comment warnings in Core.fs - #79
Merged
Conversation
`validateJson` documented only `f`, but HttpHandler expands to HttpFunc -> HttpContext -> HttpFuncResult, so F# sees three curried parameters and warns about the two undocumented ones. Its sibling `bindJson` already carries the empty `next`/`ctx` entries; this matches it. `json` had the opposite problem: it documented a `ctx` parameter it does not have. The `let bytes` hoist means the lambda is a returned value rather than further curried parameters, so only `dataObj` is a parameter. Same shape as `text` and `htmlFile`, neither of which documents `ctx`. Each warning was reported once per backend project, hence nine lines in the release build. All three projects now build with 0 warnings. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Clears the
FS3390warnings in the release build. Two distinct causes, both insrc/Core.fs.validateJson(L233) — two missing entries.HttpHandlerexpands toHttpFunc -> HttpContext -> HttpFuncResult, and the body is directly a lambda, so F# sees three curried parameters while the doc comment named onlyf. Its siblingbindJsonalready carries the emptynext/ctxentries —validateJsonwas added later and omitted them. Now matches.json(L317) — one entry too many. It documented actxparameter it doesn't have. Thelet bytes = ...hoist makes the lambda a returned value rather than further curried parameters, sodataObjis the only parameter. Same shape astextandhtmlFile, neither of which documentsctx.Each warning is reported once per backend project, which is why three warnings show up as nine lines in the release log.
Testing
-c Releasewith 0 warnings (was 3 each).just test-beam: 94 passed / 7 skipped, unchanged.Comment-only; no code touched.
🤖 Generated with Claude Code