Add improvement backlog

[domfahey]

Summary

• expand TODO list with new areas for improvement

Testing

• make check (fails: No module named pytest)

Summary by CodeRabbit

• Documentation
  • Added new backlog task sections outlining planned improvements for code cleanup, CLI enhancements, testing coverage, and documentation updates. No existing content was changed.

[coderabbitai]

Walkthrough

The change adds four new backlog task sections to the "Backlog / Follow-up Improvements" area in the todos.md file. These sections outline future work items related to code refactoring, CLI enhancements, testing improvements, and documentation updates. No existing content was altered or removed.

Changes

File(s)	Change Summary
todos.md	Appended four new backlog sections (24–27) detailing tasks for code cleanup, CLI enhancements, testing, and documentation updates.

Poem

Four new tasks hop in, neat and clear,
Refactoring code and CLI cheer,
Testing flags and docs to write,
Backlog grows with future in sight.
A rabbit’s list, ever so bright—
Onward we bound, improvements in flight!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

todos.md (4)

98-100: Add Why/Where/How/Done details to backlog item #24
The new “Code cleanup” task should follow the established backlog pattern by specifying:

• Why: rationale for factoring out the read_input logic
• Where: target modules (e.g., src/pdf_ocr_pipeline/summarize.py & src/pdf_ocr_pipeline/segment_cli.py)
• How: approach for extracting into a shared helper (function signature, refactor plan)
• Done-when: success criteria (e.g., no duplicated code, tests passing)

---

101-104: Clarify implementation plan for CLI enhancements (#25)
Please enrich this item with:

• Why: benefits of adding --version and progress indicator
• Where: which CLI entrypoints or scripts to update
• How: libraries/tools to use (e.g., argparse/click, tqdm)
• Done-when: expected behavior and tests verifying flag functionality

---

105-107: Detail testing approach for item #26
To make the testing backlog actionable, include:

• Why: goals for parsing inputs and handling logging flags
• Where: specific modules (summarize.py, segment_cli.py) or functions under test
• How: testing framework (e.g., pytest), fixtures, and CI integration steps
• Done-when: criteria such as coverage thresholds and passing make check

---

108-110: Specify location and sample for documentation update (#27)
Enhance this task by outlining:

• Why: value of documenting optional config fields for end users
• Where: README.md or docs/ file path
• How: include an INI snippet showing pdf-ocr-pipeline.ini defaults
• Done-when: documentation merged and validated in docs preview

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between d90b497 and c368b50.

📒 Files selected for processing (1)

• todos.md (1 hunks)