Repository navigation
docs: match 0.24.1 public API; drop python-docx from comments - #367
Merged
Merged
Conversation
README and the host guide now describe the real Pack path: review_tree / review_source / review_document / TaktReviewer / CLI, DecisionClient.decide, and LLMClient with capabilities plus LLMRequestOptions. Dead insertion-engine names and the unimplemented takt source-checkout knob are gone, and tests pin that contract. Comment balloon offsets still come from Docxtor-resolved paragraphs, without importing python-docx, so the package-ownership suite is consistent. Co-authored-by: Patryk Mikołajczyk <mikolaj92@users.noreply.github.com>
Ruff FURB167 rejects the re.S alias. Co-authored-by: Patryk Mikołajczyk <mikolaj92@users.noreply.github.com>
PhysicalReviewComment.anchor_text already allows None. The local quoted string was inferred as str from the resolved span, then assigned ReviewAction.original_text (str | None). Annotate it as str | None so uv run mypy is clean. Co-authored-by: Patryk Mikołajczyk <mikolaj92@users.noreply.github.com>
Co-authored-by: Patryk Mikołajczyk <mikolaj92@users.noreply.github.com>
mikolaj92
marked this pull request as ready for review
September 29, 2026 19:22
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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.
README and host docs were still selling a pre-0.24 public surface. This PR makes them match the code on main (0.24.1 Pack-only) and fixes a suite inconsistency in comment parsing.
Docs (#333–#338)
The 0.24.1 host path is typed
Pack+DecisionClient, then:review_tree— already-parsedReviewDocument, no file I/Oreview_source— inject aDocumentParser, thenreview_treereview_document— DOCX load + optionalreviewed.docx/corrected.docxTaktReviewer.reviewreviewkit input.docx --profile … --pack … --decision … --llm …LLMClientis documented as the real Protocol:capabilities: LLMCapabilitiesandcomplete_json(..., options: LLMRequestOptions | None = None). DeadParagraphInserter/InsertionValidatorclaims are gone. The unimplemented takt source-checkout environment knob is gone; ReviewKit imports the pinnedtaktpackage only.Contract tests now:
from reviewkit import …names to exist on the package rootsrc/+FALLBACKS.md)review_tree/review_source/LLMCapabilities/LLMRequestOptionsin README and the host guidesrc/reviewkitadvertiseTAKT_HOMEComments / ownership
comments.pystill computes balloonstart_offset/end_offsetfrom Docxtor-resolved paragraph XML so repeated sentences keep a unique range. It no longer imports python-docx, which the ownership test forbids. python-docx is not added as a product dependency.Typing
uv run mypy(the CONTRIBUTING /[tool.mypy]command) is clean. The remaining assignment error was inrenderer_docx.py:PhysicalReviewComment.anchor_textisstr | None, but the local quote was inferred asstrfrom a resolved span and then assignedReviewAction.original_text(str | None). Runtime is unchanged.Closes #333
Closes #334
Closes #335
Closes #336
Closes #337
Closes #338