Add footnote collection wrapping test

[leynos]

Summary

• add regression test ensuring consecutive footnotes remain on separate lines during wrapping

Testing

• make fmt
• make lint
• make test

---

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

Summary by Sourcery

Tests:

• Introduce test_wrap_footnote_collection verifying that processing a sequence of footnote definitions preserves their original ordering and formatting

[sourcery-ai]

Reviewer's Guide

This PR adds a regression test in the integration suite to verify that the wrapping logic leaves a collection of consecutive footnotes unaltered and on separate lines.

File-Level Changes

Change	Details	Files
Add footnote collection wrapping regression test	Introduce a new test function test_wrap_footnote_collection Define an input Vec of consecutive footnote lines Process the input via process_stream Assert that the output exactly matches the input	tests/integration.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

• Tests
  • Added a new test to ensure that collections of simple Markdown footnotes remain unchanged after processing.

Summary by CodeRabbit

• Tests
  • Added a new integration test to verify that collections of simple footnote lines remain unchanged after processing.

Walkthrough

Add a new integration test named test_wrap_footnote_collection to verify that a collection of Markdown footnote reference lines is not altered by the process_stream function. The test constructs a vector of such lines, processes them, and asserts that the output matches the input.

Changes

File(s)	Change Summary
tests/integration.rs	Add test_wrap_footnote_collection to test footnote line preservation

Possibly related PRs

• Add URL wrapping regression test #77: Adds tests ensuring URLs in Markdown inline links remain unchanged during processing, related to preserving Markdown constructs.
• Add footnote wrap handling #73: Implements the core footnote wrapping logic and related tests, providing the functionality that this PR’s test validates.
• Add text wrapping to mdtablefix #32: Adds text wrapping features and tests to process_stream, relating to this PR by targeting the same function but focusing on different aspects.

Poem

Footnotes gather, neat in a row,
Through process_stream, they bravely go.
Not a mark changed, not a line bent—
The test assures their firm intent.
Markdown’s order, kept precise,
A passing check—oh, isn’t that nice!

---

📜 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 ff386e1 and 4a2492c.

📒 Files selected for processing (1)

• tests/integration.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

• AGENTS.md

⚙️ CodeRabbit Configuration File

🧬 Code Graph Analysis (1)

tests/integration.rs (1)

src/lib.rs (1)

• process_stream (749-749)

🔇 Additional comments (1)

tests/integration.rs (1)

745-767: Well-implemented regression test for footnote collection.

The test correctly verifies that a sequence of footnote references remains unchanged during stream processing. The documentation comment adequately explains the test's purpose and the implementation follows proper testing patterns.

✨ 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-footnote-formatting

---

🪧 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 they look great!

---

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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8b38203 and ff386e1.

📒 Files selected for processing (1)

• tests/integration.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

🧬 Code Graph Analysis (1)

tests/integration.rs (1)

src/lib.rs (1)

• process_stream (749-749)