docs: refresh README for shipped entrypoint / diff / polyglot / API work#15
Merged
Conversation
The README had drifted during the recent feature sprint. This catches it up: - QueryEngine methods table now lists all 16 public methods, including the six added since the last README update (ancestors_of, reachable_from, entrypoint_paths_to, functions_that_raise, nodes_with_annotation, diff_against). - "Declaring entrypoints" section replaced with "Entrypoint detection", reflecting the four-layer detection that actually ships today (generic main + framework-aware + pyproject scripts + override file). Adds a coverage table listing the ~12 languages × 30+ frameworks currently detected, and a link to docs/entrypoint-patterns.md as the full spec for contributors adding new detectors. - Programmatic API example now showcases auto-language detection, transitive slicing, entrypoint-paths-to, functions_that_raise, and diff_against. - Normalized compact `|---|---|` table separators to `| --- | --- |` to stop the markdown-lint warnings that have been firing on every edit to this file. Also updates tests/test_readme.py EXPECTED_METHODS to include the new QueryEngine methods so the regression guard actually catches drift in both directions going forward. Co-Authored-By: Claude Opus 4.6 (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.
The README had drifted during the recent feature sprint. This catches it up:
|---|---|table separators to| --- | --- |to stop the markdown-lint warnings that have been firing on every edit to this file.Also updates tests/test_readme.py EXPECTED_METHODS to include the new QueryEngine methods so the regression guard actually catches drift in both directions going forward.