Skip to content

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

Merged
vitali87 merged 1 commit into
mainfrom
docs/trim-latest-news
Mar 28, 2026
Merged

docs: trim Latest News to three most recent features#40
vitali87 merged 1 commit into
mainfrom
docs/trim-latest-news

Conversation

@vitali87

Copy link
Copy Markdown
Owner

Summary

  • Drop the Auto-derived Minimum LOC bullet from Latest News to keep the section at three items

Test plan

  • Verify rendering on GitHub

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread README.md
- 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.

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.

@greptile-apps

greptile-apps Bot commented Mar 28, 2026

Copy link
Copy Markdown

Greptile Summary

This is a documentation-only PR that removes one bullet point (Auto-derived Minimum LOC) from the README.md "Latest News" section, keeping the list at three items as intended.

  • Removes the Auto-derived Minimum LOC entry from README.md to trim the section to three bullets.
  • No code logic, tests, or configuration is affected.
  • The remaining three entries accurately represent the most recent features.

Confidence Score: 5/5

This 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

Filename Overview
README.md Removes the "Auto-derived Minimum LOC" bullet from the Latest News section, trimming it from four items to three.

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"]
Loading

Reviews (1): Last reviewed commit: "docs: trim Latest News to three most rec..." | Re-trigger Greptile

@vitali87 vitali87 merged commit adad0c2 into main Mar 28, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant