Conversation
Contributor
Reviewer's GuideRefactors the text processing pipeline to make wrapping opt-in via a new Sequence Diagram: Conditional Text Processing with --wrap FlagsequenceDiagram
actor User
participant CLI_Main as "CLI (main.rs)"
participant Lib_PublicAPI as "lib.rs (Functions)"
participant Lib_Inner as "lib.rs (process_stream_inner)"
User->>CLI_Main: Executes mdtablefix (optional --wrap)
CLI_Main->>CLI_Main: Parses arguments (sets wrap_flag)
alt wrap_flag is true
CLI_Main->>Lib_PublicAPI: Calls wrapping function (e.g., process_stream or rewrite)
Lib_PublicAPI->>Lib_Inner: process_stream_inner(data, true)
Lib_Inner-->>Lib_PublicAPI: Wrapped lines
Lib_PublicAPI-->>CLI_Main: Result with wrapped lines
else wrap_flag is false
CLI_Main->>Lib_PublicAPI: Calls non-wrapping function (e.g., process_stream_no_wrap or rewrite_no_wrap)
Lib_PublicAPI->>Lib_Inner: process_stream_inner(data, false)
Lib_Inner-->>Lib_PublicAPI: Non-wrapped lines
Lib_PublicAPI-->>CLI_Main: Result with non-wrapped lines
end
CLI_Main->>User: Outputs processed text
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
WalkthroughThis update introduces a Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant Library
User->>CLI: Run mdtablefix [--wrap] [file]
CLI->>CLI: Parse CLI arguments
alt --wrap is set
CLI->>Library: process_stream / rewrite (with wrapping)
else --wrap not set
CLI->>Library: process_stream_no_wrap / rewrite_no_wrap (no wrapping)
end
Library-->>CLI: Processed output
CLI-->>User: Output to stdout or file
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
✨ Finishing Touches
🪧 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
added a commit
that referenced
this pull request
Jun 15, 2025
Docstrings generation was requested by @leynos. * #38 (comment) The following files were modified: * `src/html.rs` * `src/lib.rs` * `src/main.rs` * `tests/integration.rs`
Contributor
|
Note Generated docstrings for this pull request at #39 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
src/main.rs (1)
47-52: Minor duplication – extract helper to reduce branchingThe
if cli.wrap { … } else { … }block appears three times. Extracting a small helper (e.g.fn process(lines: &[String], wrap: bool) -> Vec<String>) would remove repetition and make future adjustments (different widths, etc.) less error-prone.Pure refactor; no functional bug.
Also applies to: 58-63, 66-71
src/html.rs (1)
215-225: Public exposure of internal helper twice
html_table_to_markdownis nowpub #[doc(hidden)]and re-exported at the crate root with the same visibility. This leaks the symbol via two paths (mdtablefix::html::html_table_to_markdownandmdtablefix::html_table_to_markdown). If complete hiding is the goal, consider:-#[doc(hidden)] -pub fn html_table_to_markdown(…) +pub(crate) fn html_table_to_markdown(…)and keep only the crate-level re-export tagged with
#[doc(hidden)].
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
README.md(2 hunks)src/html.rs(2 hunks)src/lib.rs(8 hunks)src/main.rs(3 hunks)tests/integration.rs(1 hunks)
🔇 Additional comments (2)
README.md (1)
4-5: Documentation update looks goodThe README now accurately reflects the opt-in behaviour via
--wrap. No further issues spotted.Also applies to: 24-29
src/lib.rs (1)
505-513: Wrapper functions read cleanly
process_stream/process_stream_no_wrapcorrectly delegate to the shared inner helper. Nice separation of concerns.
Owner
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--wrap--wrapusage in READMEprocess_stream_no_wrapandrewrite_no_wrapTesting
cargo fmtcargo clippy -- -D warningsRUSTFLAGS="-D warnings" cargo testmarkdownlint README.mdhttps://chatgpt.com/codex/tasks/task_e_684e4d1908988322aabbcb892045e7a4
Summary by Sourcery
Add an optional wrapping flag to make text wrapping opt-in and provide no-wrap variants for processing and in-place rewriting
New Features:
--wrapCLI option to enable paragraph and list wrappingprocess_stream_no_wrapandrewrite_no_wrapto skip wrappingEnhancements:
Documentation:
--wrapusage in READMETests:
--wrapoptionSummary by CodeRabbit
--wrapto control paragraph and list item wrapping to 80 columns.--wrapoption.--wrapcommand-line option.