Conversation
Reviewer's Guiderenumber_lists now treats blank lines as transparent to ordered list numbering, the documentation has been updated accordingly, and a new regression test verifies renumbering across blank lines. Class diagram for renumber_lists function updateclassDiagram
class renumber_lists {
+renumber_lists(lines: &[String]) -> Vec<String>
}
renumber_lists : +Ignores blank lines when renumbering
renumber_lists : +Maintains numbering across blank lines
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary by CodeRabbit
WalkthroughUpdate the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant renumber_lists
User->>CLI: Run with --renumber option
CLI->>renumber_lists: Pass input lines
loop For each line
renumber_lists->>renumber_lists: Detect blank line?
alt Blank line
renumber_lists->>renumber_lists: Append blank line, set prev_blank, continue
else Numbered list line
renumber_lists->>renumber_lists: Renumber as needed
end
end
renumber_lists-->>CLI: Output renumbered lines
CLI-->>User: Show result
Estimated code review effort2 (~12 minutes) Possibly related issues
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
📓 Path-based instructions (1)**/*.md📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
⚙️ CodeRabbit Configuration File
Files:
🧰 Additional context used📓 Path-based instructions (1)**/*.md📄 CodeRabbit Inference Engine (AGENTS.md)
Files:
⚙️ CodeRabbit Configuration File
Files:
⏰ Context from checks skipped due to timeout of 240000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (1)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
README.md(1 hunks)src/lists.rs(1 hunks)tests/data/renumber_blank_lines_expected.txt(1 hunks)tests/data/renumber_blank_lines_input.txt(1 hunks)tests/lists.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.md
📄 CodeRabbit Inference Engine (AGENTS.md)
**/*.md: Validate Markdown files usingmake markdownlint.
Runmake fmtafter any documentation changes to format all Markdown files and fix table markup.
Validate Mermaid diagrams in Markdown files by runningmake nixie.
Markdown paragraphs and bullet points must be wrapped at 80 columns.
Code blocks must be wrapped at 120 columns.
Tables and headings must not be wrapped.
Use dashes (-) for list bullets.
Use GitHub-flavoured Markdown footnotes ([^1]) for references.
Files:
README.md
⚙️ CodeRabbit Configuration File
**/*.md: * Avoid 2nd person or 1st person pronouns ("I", "you", "we")
- Use en-GB-oxendict (-ize / -our) spelling and grammar
- Paragraphs and bullets must be wrapped to 80 columns, except where a long URL would prevent this (in which case, silence MD013 for that line)
- Code blocks should be wrapped to 120 columns.
- Headings must not be wrapped.
- Documents must start with a level 1 heading
- Headings must correctly increase or decrease by no more than one level at a time
- Use GitHub-flavoured Markdown style for footnotes and endnotes.
- Numbered footnotes must be numbered by order of appearance in the document.
Files:
README.md
**/*.rs
📄 CodeRabbit Inference Engine (AGENTS.md)
**/*.rs: Comments must use en-GB-oxendict spelling and grammar.
Function documentation must include clear examples.
Every module must begin with a module level (//!) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.
Do not usereturnin single-line functions.
Prefer immutable data and avoid unnecessarymutbindings.
Handle errors with theResulttype instead of panicking where feasible.
Avoidunsafecode unless absolutely necessary and document any usage clearly.
Clippy warnings MUST be disallowed.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Preferexpectoverallow.
Prefer.expect()over.unwrap().
Useconcat!()to combine long string literals rather than escaping newlines with a backslash.
Use predicate functions for conditional criteria with more than two branches.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider usingArcto reduce the amount of data returned.
Comment why, not what. Explain assumptions, edge cases, trade-offs, or complexity. Don't echo the obvious.
Use functions and composition. Avoid repetition by extracting reusable logic. Prefer generators or comprehensions, and declarative code to imperative repetition when readable.
Small, meaningful functions. Functions must be small, clear in purpose, single responsibility, and obey command/query segregation.
Name things precisely. Use clear, descriptive variable and function names. For booleans, prefer names withis,has, orshould.
Structure log...
Files:
src/lists.rstests/lists.rs
⚙️ CodeRabbit Configuration File
**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.
Adhere to single responsibility and CQRS
Place function attributes after doc comments.
Do not use
returnin single-line functions.Move conditionals with >2 branches into a predicate function.
Avoid
unsafeunless absolutely necessary.Every module must begin with a
//!doc comment that explains the module's purpose and utility.Comments and docs must follow en-GB-oxendict (-ize / -our) spelling and grammar
Lints must not be silenced except as a last resort.
#[allow]is forbidden.- Only narrowly scoped
#[expect(lint, reason = "...")]is allowed.- No lint groups, no blanket or file-wide suppression.
- Include
FIXME:with link if a fix is expected.Use
rstestfixtures for shared setup and to avoid repetition between tests.Replace duplicated tests with
#[rstest(...)]parameterised cases.Prefer
mockallfor mocks/stubs.Prefer
.expect()over.unwrap()Ensure that any API or behavioural changes are reflected in the documentation in
docs/Ensure that any completed roadmap steps are recorded in the appropriate roadmap in
docs/Files must not exceed 400 lines in length
- Large modules must be decomposed
- Long match statements or dispatch tables should be decomposed by domain and collocated with targets
- Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.
Files:
src/lists.rstests/lists.rs
🪛 LanguageTool
tests/data/renumber_blank_lines_input.txt
[typographical] ~1-~1: To join two clauses or introduce examples, consider using an em dash.
Context: 1. pyo3::marker - Rust, accessed on July 14, 2025, <h...
(DASH_RULE)
[typographical] ~4-~4: To join two clauses or introduce examples, consider using an em dash.
Context: .../> 1. Supporting Free-Threaded Python - PyO3 user guide, accessed on July 14, ...
(DASH_RULE)
[typographical] ~7-~7: To join two clauses or introduce examples, consider using an em dash.
Context: .../pyo3.rs/main/free-threading> 1. pyo3 - Rust - Docs.rs, access...
(DASH_RULE)
[typographical] ~7-~7: To join two clauses or introduce examples, consider using an em dash.
Context: ...s/main/free-threading> 1. pyo3 - Rust - Docs.rs, accessed on J...
(DASH_RULE)
[typographical] ~10-~10: To join two clauses or introduce examples, consider using an em dash.
Context: ...://docs.rs/pyo3/0.25.1/pyo3/> 1. pyo3 - Rust - Docs.rs, access...
(DASH_RULE)
[typographical] ~10-~10: To join two clauses or introduce examples, consider using an em dash.
Context: ....rs/pyo3/0.25.1/pyo3/> 1. pyo3 - Rust - Docs.rs, accessed on J...
(DASH_RULE)
README.md
[uncategorized] ~42-~42: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Blank lines between items are ignored so numbering continues uninterrupted. - U...
(COMMA_COMPOUND_SENTENCE_2)
tests/data/renumber_blank_lines_expected.txt
[typographical] ~1-~1: To join two clauses or introduce examples, consider using an em dash.
Context: 1. pyo3::marker - Rust, accessed on July 14, 2025, <h...
(DASH_RULE)
[typographical] ~4-~4: To join two clauses or introduce examples, consider using an em dash.
Context: .../> 2. Supporting Free-Threaded Python - PyO3 user guide, accessed on July 14, ...
(DASH_RULE)
[typographical] ~7-~7: To join two clauses or introduce examples, consider using an em dash.
Context: .../pyo3.rs/main/free-threading> 3. pyo3 - Rust - Docs.rs, access...
(DASH_RULE)
[typographical] ~7-~7: To join two clauses or introduce examples, consider using an em dash.
Context: ...s/main/free-threading> 3. pyo3 - Rust - Docs.rs, accessed on J...
(DASH_RULE)
[typographical] ~10-~10: To join two clauses or introduce examples, consider using an em dash.
Context: ...://docs.rs/pyo3/0.25.1/pyo3/> 4. pyo3 - Rust - Docs.rs, access...
(DASH_RULE)
[typographical] ~10-~10: To join two clauses or introduce examples, consider using an em dash.
Context: ....rs/pyo3/0.25.1/pyo3/> 4. pyo3 - Rust - Docs.rs, accessed on J...
(DASH_RULE)
🔇 Additional comments (4)
tests/data/renumber_blank_lines_input.txt (1)
1-12: Test data correctly demonstrates the blank line scenario.The input file properly sets up the test case with incorrectly numbered list items (all numbered "1.") separated by blank lines. This effectively tests that the renumbering logic handles blank lines correctly.
tests/data/renumber_blank_lines_expected.txt (1)
1-12: Expected output correctly demonstrates the desired renumbering behaviour.The expected results show proper sequential numbering (1, 2, 3, 4) whilst preserving the blank lines between list items. This aligns perfectly with the PR objective of ensuring blank lines don't interrupt the renumbering process.
src/lists.rs (1)
98-102: Explicit blank line handling correctly preserves blank lines and maintains state.The implementation properly detects blank lines using
trim().is_empty(), preserves them in the output, and sets theprev_blankflag before continuing. This ensures blank lines don't interfere with the renumbering logic whilst being preserved in the output.tests/lists.rs (1)
127-130: Test case properly validates blank line handling.The new
blank_linestest case follows the established pattern using the rstest framework and external data files. This provides comprehensive coverage of the blank line renumbering functionality.
1 participant
Summary
Testing
make fmtmake lintmake testhttps://chatgpt.com/codex/tasks/task_e_687ea87e7b748322b9eae5cc77a29507
Summary by Sourcery
Ignore blank lines when renumbering ordered lists to maintain continuous numbering across blank lines, update documentation accordingly, and add regression tests
Bug Fixes:
Documentation:
Tests: