Skip to content

Fix import path and run fmt#170

Merged
leynos merged 2 commits intomainfrom
us7sxd-codex/fix-lint-errors-in-mdtablefix
Aug 1, 2025
Merged

Fix import path and run fmt#170
leynos merged 2 commits intomainfrom
us7sxd-codex/fix-lint-errors-in-mdtablefix

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Aug 1, 2025

Summary

  • re-export tokenize_markdown with inline docs
  • run fmt after updating the code

Testing

  • make lint
  • make check-fmt
  • make test

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

Summary by Sourcery

Re-export tokenize_markdown with inline docs, reflow markdown and clean up formatting, and apply rustfmt formatting across the codebase

Enhancements:

  • Add #[doc(inline)] re-export of tokenize_markdown in wrap.rs

Documentation:

  • Reflow AGENTS.md text to fix line wrapping

Tests:

  • Remove trailing whitespace in test macro comment

Chores:

  • Apply rustfmt formatting across codebase

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 1, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 37 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7fd4cb3 and abe5153.

📒 Files selected for processing (1)
  • src/wrap.rs (1 hunks)

Summary by CodeRabbit

  • Documentation

    • Improved readability in the "Dependency Management" section of the documentation.
    • Removed a trailing space from a documentation comment in test code.
  • Refactor

    • Refactored logic in the function that checks for bold elements to improve clarity without changing behaviour.
  • New Features

    • Made a markdown tokenisation function publicly accessible for external use via the wrapping module.

Walkthrough

Reformat the documentation in AGENTS.md for clarity, refactor the conditional logic in the contains_strong function for readability, re-export the tokenize_markdown function in wrap.rs, and remove a trailing space in a documentation comment in the test module. No functional changes are introduced.

Changes

Cohort / File(s) Change Summary
Documentation Formatting
AGENTS.md
Reformatted a paragraph in the "Dependency Management" section for improved readability; content remains unchanged.
Logic Refactor
src/html.rs
Refactored the contains_strong function to use nested if statements for clarity; functional behaviour unchanged.
Public API Re-export
src/wrap.rs
Added a public re-export of tokenize_markdown from the internal tokenize module with inline documentation.
Test Doc Clean-up
tests/common/mod.rs
Removed a trailing space in a documentation comment; no effect on logic or functionality.

Sequence Diagram(s)

sequenceDiagram
    participant External as External Caller
    participant Wrap as wrap.rs
    participant Tokenize as tokenize module

    External->>Wrap: Call tokenize_markdown(...)
    Wrap->>Tokenize: Forward call to tokenize_markdown(...)
    Tokenize-->>Wrap: Return result
    Wrap-->>External: Return result
Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

Refactor, re-export, and docs align,
Each change precise, each edit fine.
A space removed, a function shared,
Code and comments neatly paired.
With lines wrapped tight and logic clear,
This tidy patch deserves a cheer!
🦾✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch us7sxd-codex/fix-lint-errors-in-mdtablefix

🪧 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 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
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Aug 1, 2025

Reviewer's Guide

This PR introduces a convenience re-export of the Markdown tokenizer with inline documentation, refactors the HTML parsing helper for improved readability, and applies rustfmt-driven formatting and documentation cleanups across code and docs.

Class diagram for re-exporting tokenize_markdown in wrap.rs

classDiagram
    class tokenize {
        +Token
        +tokenize_markdown()
    }
    class wrap {
        +Token
        +tokenize_markdown()
    }
    wrap ..> tokenize : re-exports
Loading

Class diagram for refactored contains_strong function in html.rs

classDiagram
    class Handle {
        +data: NodeData
        +children: Vec<Handle>
    }
    class NodeData {
        +Element
        +name: Name
    }
    class Name {
        +local: String
    }
    Handle --> NodeData
    NodeData --> Name
    Handle --> Handle : children
    class html {
        +contains_strong(handle: &Handle) bool
        +is_bold_tag(tag: &str) bool
    }
    html ..> Handle
    html ..> NodeData
    html ..> Name
Loading

File-Level Changes

Change Details Files
Added convenience re-export of tokenize_markdown with inline documentation
  • Added pub use tokenize::tokenize_markdown
  • Annotated the re-export with #[doc(inline)]
  • Updated module doc comment to reference the new re-export
src/wrap.rs
Refactored contains_strong implementation for clarity
  • Replaced combined if-let guard with nested if statements
  • Encapsulated is_bold_tag check inside a separate if block
src/html.rs
Cleaned up documentation and formatting via rustfmt
  • Rewrapped long lines in AGENTS.md
  • Removed trailing whitespace in a macro doc example
  • Ran rustfmt to align code with style guidelines
AGENTS.md
tests/common/mod.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

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @leynos - I've reviewed your changes - here's some feedback:

  • Consider using the matches! macro with a guard to simplify the contains_strong logic into a single expression instead of nested if let/if blocks.
  • You can consolidate the two pub use tokenize re-exports into one grouped statement (e.g. pub use tokenize::{Token, #[doc(inline)] tokenize_markdown};) to reduce repetition.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider using the `matches!` macro with a guard to simplify the `contains_strong` logic into a single expression instead of nested `if let`/`if` blocks.
- You can consolidate the two `pub use tokenize` re-exports into one grouped statement (e.g. `pub use tokenize::{Token, #[doc(inline)] tokenize_markdown};`) to reduce repetition.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos leynos merged commit 98271f8 into main Aug 1, 2025
1 of 2 checks passed
@leynos leynos deleted the us7sxd-codex/fix-lint-errors-in-mdtablefix branch August 1, 2025 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant