v0.3.24 - Fix Rule Conflict (qe-writing-002 vs qe-writing-001)
Bug Fix 🐛
Prevents qe-writing-002 from creating violations of qe-writing-001 when suggesting to break up long sentences.
Problem
qe-writing-002 was suggesting to break long sentences into multiple sentences, but NOT adding blank lines between them:
❌ Bad suggestion:
But we can model time series with persistent growth. These models use a law of large numbers.This violated qe-writing-001 (one sentence per paragraph - separated by blank lines).
Solution
- ✅ Added inline constraint to qe-writing-002: "Breaking long sentences up can be useful sometimes, but each sentence must be in its own paragraph block separated by blank lines"
- ✅ Changed category from
ruletostyle(advisory rather than mechanical) - ✅ Self-contained explanation (no need for external links)
Correct Behavior Now
✅ Good suggestion:
But we can model time series with persistent growth.
These models use a law of large numbers.Impact
- Prevents conflicting edits between rules processed sequentially
- Maintains consistency with qe-writing-001
- Clear guidance for LLM on proper sentence breaking
Full Changelog: https://github.com/QuantEcon/action-style-guide/blob/main/CHANGELOG.md