Skip to content

docs: trim Latest News to three most recent features #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vitali87 merged 1 commit into from
Mar 28, 2026
Merged

docs: trim Latest News to three most recent features #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
- 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.

@gemini-code-assist gemini-code-assist Bot Mar 28, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.


## Why pr-split?

Expand Down
Loading