Fix doc comment typos and gitignore MCP server logs #none - #16
Merged
Conversation
Fix five doc-comment defects in seq.go: a stray closing brace in the KV usage example (which rendered broken on pkg.go.dev), an 'an the' typo in CompactFunc, 'starts of the sequence' in Drop and DropKV, and 'built in' vs 'builtin' inconsistency between Min and Max. Also ignore logs/, which the git-mcp-server writes into the working directory, so it can't be committed by accident. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Rvh5bZ6e5G62UApzeEd6gB
Contributor
There was a problem hiding this comment.
Pull request overview
Docs/tooling-only cleanup for the seq Go library: it corrects several doc comment typos (including a malformed snippet) and updates .gitignore to avoid noise from the git MCP server’s local log output.
Changes:
- Fix a syntax error in the
KVdoc comment example (remove stray}) so the rendered snippet is no longer malformed. - Correct multiple documentation typos/wording issues (
Min,CompactFunc,Drop,DropKV). - Ignore
logs/in.gitignoreto prevent MCP server log directories from showing up as untracked files.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| seq.go | Documentation-only fixes to examples and doc comments (no code behavior changes). |
| .gitignore | Ignore logs/ directory created by git MCP server logs to reduce untracked-file noise. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Docs-only cleanup found during a bug hunt over
seq.go(no behavioral bugs turned up — the logic checked out against a differential edge-case harness covering early breaks at every position, empty/negative/oversized inputs, chunk/window aliasing, and iterator reusability).KVdoc example — as written, the example didn't compile and renders on pkg.go.devCompactFuncdocDropandDropKVMin's "built in" wording withMax's "builtin"logs/to.gitignore: the git MCP server writes its logs into the working directory, and they were showing up as untracked filesTesting
go vet ./...cleanstaticcheck ./...cleango test -race -count=2 ./...passes for both packagesgofmt -lcleanTagged
none— docs and tooling only, no release.🤖 Generated with Claude Code
https://claude.ai/code/session_01Rvh5bZ6e5G62UApzeEd6gB