docs: trim Latest News to three most recent features#40
Conversation
There was a problem hiding this comment.
Code Review
This pull request removes the documentation for the 'Auto-derived Minimum LOC' feature from the README. Feedback suggests relocating this information to the 'Options' table instead of deleting it, as the feature remains active in the implementation.
| - GitHub Action — add pr-split to any repo as a CI check. Scores every PR and posts a split plan comment when it's too large. No API key needed. | ||
| - Smart LOC Bounds — set `--min-loc` and `--max-loc` to control sub-PR size across all three backends (LLM, graph, CP-SAT). Undersized groups get merged, oversized groups get penalised. | ||
| - LLM Refinement Loop — enable `--max-refinement-iterations` and pr-split will automatically feed LOC violations back to the LLM until every group fits within your configured bounds. | ||
| - Auto-derived Minimum LOC — when refinement is on and no `--min-loc` is set, pr-split picks a sensible default (25% of `--max-loc`) so you get well-sized groups out of the box. |
There was a problem hiding this comment.
While the goal of trimming the 'Latest News' section is understandable, removing this line completely removes the only documentation for the automatic derivation of min-loc. This is a useful feature that improves the user experience, and its behavior is not obvious.
The feature is still implemented in pr_split/config.py in the auto_derive_min_loc method, and is covered by tests in tests/test_config.py.
Could you please move this information to a more permanent location in the documentation, such as the description for --min-loc in the 'Options' table? This would ensure the feature remains discoverable by users.
Greptile SummaryThis is a documentation-only PR that removes one bullet point (
Confidence Score: 5/5This PR is safe to merge — it is a one-line documentation removal with no code impact. The change is purely cosmetic: one bullet point deleted from the README. No logic, tests, or configuration is touched, and the remaining content is accurate. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["Latest News Section (before)"] --> B["GitHub Action"]
A --> C["Smart LOC Bounds"]
A --> D["LLM Refinement Loop"]
A --> E["Auto-derived Minimum LOC ❌ removed"]
F["Latest News Section (after)"] --> G["GitHub Action"]
F --> H["Smart LOC Bounds"]
F --> I["LLM Refinement Loop"]
Reviews (1): Last reviewed commit: "docs: trim Latest News to three most rec..." | Re-trigger Greptile |
Summary
Test plan