Add list restart test for formatted paragraphs

[leynos]

Summary

• handle formatted paragraphs as plain paragraphs
• add regression test using sample Slipcover text
• add unit test for formatted paragraph case

Testing

• make lint
• make test

---

https://chatgpt.com/codex/tasks/task_e_6878db4e32f88322a1a466414b729b37

Summary by Sourcery

Allow list numbering to restart after formatted paragraphs and add corresponding tests

New Features:

• Treat paragraphs starting with formatting markers (*, _, `) as plain paragraphs for list renumbering

Tests:

• Add integration and unit tests for restarting list numbering after formatted paragraphs
• Include regression test using sample Slipcover text for formatted paragraph case

[sourcery-ai]

Reviewer's Guide

Update paragraph detection to treat formatted paragraphs as plain paragraphs, and add integration and unit tests to verify list numbering restarts after formatted paragraphs.

File-Level Changes

Change	Details	Files
Recognize formatted paragraphs in paragraph detection	Trim leading formatting markers (*, _, `) before checking for alphanumeric start Integrate trim into existing is_plain_paragraph_line logic	src/lists.rs
Add integration test for restarting list numbering after formatted paragraph	Create new test function loading input and expected files Use include_str! to read sample Slipcover text files Assert renumber_lists output matches expected	tests/integration.rs tests/data/renumber_formatting_paragraph_input.txt tests/data/renumber_formatting_paragraph_expected.txt
Add unit test for formatted paragraph restart behavior	Define inline lines_vec! input with bold intro Define expected lines_vec! with restarted numbering Assert renumber_lists produces expected result	tests/lists.rs

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of paragraphs with markdown formatting, ensuring correct identification and processing of plain paragraph lines.
• Tests
  • Added new tests to verify correct list renumbering after paragraphs containing markdown formatting.
  • Introduced integration tests using external data files to validate list renumbering logic in formatted paragraphs.

Walkthrough

Expand the logic in is_plain_paragraph_line to trim leading *, _, and ` characters before checking for alphanumeric content. Add new integration and unit tests to verify correct list renumbering after paragraphs with markdown formatting. Introduce supporting test data files for these scenarios.

Changes

File(s)	Change Summary
src/lists.rs	Update is_plain_paragraph_line to trim leading *, _, and ` before alphanumeric check.
tests/integration.rs	Add test function test_renumber_restart_after_formatting_paragraph using external data files.
tests/lists.rs	Add unit test restart_after_formatting_paragraph for list renumbering after formatted paragraphs.
tests/data/renumber_formatting_paragraph_input.txt tests/data/renumber_formatting_paragraph_expected.txt	Add input and expected output files describing Slipcover and pytest-forked integration scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Function
    participant File as Input File
    participant Lists as renumber_lists
    participant Output as Output File

    Test->>File: Read input lines
    Test->>Lists: Call renumber_lists(input)
    Lists->>Lists: Process lines, trim *, _, ` in paragraphs
    Lists-->>Test: Return renumbered output
    Test->>Output: Compare with expected output

Loading

Possibly related PRs

• Add renumber restart test #82: Extends the paragraph detection logic in is_plain_paragraph_line by handling additional leading characters, closely related to the changes in this PR.

Poem

In the land of lists where numbers roam,
Markdown stars and underscores call home.
Now trimmed and neat, the lines align,
Bold paragraphs no longer misdefine.
With tests anew and logic tight,
Renumbering lists just feels right!
✨🔢

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1d8f300 and 0f20d9c.

📒 Files selected for processing (1)

• src/lists.rs (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

• AGENTS.md

⚙️ CodeRabbit Configuration File

🔇 Additional comments (2)

src/lists.rs (2)

7-8: Excellent implementation of the formatting characters constant.

The constant declaration properly addresses the performance concern from the previous review about avoiding array recreation on every function call. The naming is clear and follows Rust conventions.

---

34-34: Correct implementation of formatting character trimming.

The modification to trim_start_matches using the FORMATTING_CHARS constant correctly implements the requirement to treat paragraphs with leading formatting markers as plain paragraphs for list numbering purposes. The logic maintains backward compatibility whilst extending functionality as intended.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/add-test-for-markdown-list-numbering

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sourcery-ai]

Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[leynos]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 5

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5aa673c and 1d8f300.

📒 Files selected for processing (5)

• src/lists.rs (1 hunks)
• tests/data/renumber_formatting_paragraph_expected.txt (1 hunks)
• tests/data/renumber_formatting_paragraph_input.txt (1 hunks)
• tests/integration.rs (1 hunks)
• tests/lists.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

🧬 Code Graph Analysis (1)

tests/lists.rs (1)

src/lists.rs (1)

• renumber_lists (68-119)

🔇 Additional comments (2)

tests/lists.rs (1)

58-63: Solid regression coverage

The test accurately captures the new behaviour and keeps the suite readable.

tests/integration.rs (1)

1068-1079: Integration test fills the realism gap

The end-to-end check with external data files ensures real-world scenarios stay green.