Improve token dispatch macro documentation

[leynos]

Summary

• document the token_dispatch! macro in detail
• rename dispatch_tokens! to token_dispatch!
• adjust parameter names for clarity

Testing

• make fmt
• make lint
• make test

---

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

Summary by Sourcery

Improve the token dispatch macro by renaming it for clarity, adjusting its parameters, and adding detailed documentation

Enhancements:

• Rename the dispatch_tokens! macro to token_dispatch! and update all call sites
• Adjust parameter names in the macro signature for clearer intent

Documentation:

• Add comprehensive documentation for the token_dispatch! macro usage

[sourcery-ai]

Reviewer's Guide

This PR renames the token dispatch macro from dispatch_tokens! to token_dispatch!, updates its parameter names for improved clarity, and enriches its documentation with detailed explanations and usage examples.

Flow diagram for updated token dispatch macro usage

flowchart TD
    A[Start: Initialize State] --> B{Call token_dispatch! macro}
    B -->|SyntaxKind::K_IMPORT| C[handle_import]
    B -->|SyntaxKind::K_TYPEDEF| D[handle_typedef]
    B -->|SyntaxKind::K_EXTERN| E[handle_extern]
    C --> F[Continue]
    D --> F
    E --> F
    F[End]

Loading

File-Level Changes

Change	Details	Files
Renamed macro and updated invocation sites	Replaced all dispatch_tokens! calls with token_dispatch! Updated matching arms to use the new macro name	src/parser/mod.rs
Adjusted macro parameter names for clarity	Renamed generic parameters to explicit names (e.g., st→state, tokens→token_stream) Refined handler mapping syntax for readability	src/parser/mod.rs src/macros.rs
Enhanced macro documentation	Added detailed doc comments explaining each parameter Included usage examples and expected behavior notes	src/parser/mod.rs src/macros.rs

Possibly linked issues

• Add parser porting plan #1: The PR implements documentation and renaming proposed in the issue to improve macro clarity.

---

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

• Documentation

  • Updated macro documentation and usage examples for improved clarity regarding expected parameters and behaviour.

• Refactor

  • Renamed a parsing macro and its parameters for clearer context and readability.
  • Updated all macro invocations to use the new naming convention.

Walkthrough

The macro previously named dispatch_tokens in the parser module has been renamed to token_dispatch, with its parameters and documentation updated for clarity. All usages and references within the file have been revised to reflect the new macro name and parameter conventions.

Changes

File(s)	Change Summary
src/parser/mod.rs	Renamed macro dispatch_tokens to token_dispatch, updated parameter names, documentation, and all invocations.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant token_dispatch
    participant Handler

    Caller->>token_dispatch: Invoke macro with ctx, tokens, handlers
    loop While ctx.cursor < tokens.len()
        token_dispatch->>Handler: Match token kind, call handler(ctx, token.span)
        alt No handler matched
            token_dispatch->>token_dispatch: Increment ctx.cursor by 1
        end
    end

Loading

Possibly related issues

• Improve token_dispatch! macro readability and documentation #18: This PR directly implements the renaming and refactoring of the dispatch_tokens macro as described in the issue, improving readability and documentation.

Poem

In the parser's warren, a macro took flight,
From dispatch_tokens to token_dispatch—just right!
With ctx and tokens, the code's now more clear,
Each handler hops in when its syntax is near.
The cursor advances, the tokens parade,
Hooray for the changes this rabbit has made! 🐇✨

---

📜 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 525abc7 and e5b2534.

📒 Files selected for processing (1)

• src/parser/mod.rs (3 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

`**/*.rs`: Document public APIs using Rustdoc comments (`///`) so documentation ...

**/*.rs: Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Every module must begin with a module level (//!) comment explaining the module's purpose and utility.
Place function attributes after doc comments.
Do not use return in single-line functions.
Use predicate functions for conditional criteria with more than two branches.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Prefer .expect() over .unwrap().
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.
Use explicit version ranges in Cargo.toml and keep dependencies up-to-date.
Use rstest fixtures for shared setup.
Replace duplicated tests with #[rstest(...)] parameterised cases.
Prefer mockall for mocks/stubs.
Clippy warnings MUST be disallowed.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Write unit and behavioural tests for new functionality. Run both before and after making any change.

📄 Source: CodeRabbit Inference Engine (AGENTS.md)

List of files the instruction was applied to:

• src/parser/mod.rs

`**/*.rs`: * Seek to keep the cyclomatic complexity of functions no more than 12...

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

• Adhere to single responsibility and CQRS

• Place function attributes after doc comments.

• Do not use return in single-line functions.

• Move conditionals with >2 branches into a predicate function.

• Avoid unsafe unless absolutely necessary.

• Every module must begin with a //! doc comment that explains the module's purpose and utility.

• Comments must use en-GB-oxendict spelling and grammar.

• Lints must not be silenced except as a last resort.

  • #[allow] is forbidden.
  • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
  • No lint groups, no blanket or file-wide suppression.
  • Include FIXME: with link if a fix is expected.

• Use rstest fixtures for shared setup and to avoid repetition between tests.

• Replace duplicated tests with #[rstest(...)] parameterised cases.

• Prefer mockall for mocks/stubs.

• Prefer .expect() over .unwrap()

• Ensure that any API or behavioural changes are reflected in the documentation in docs/

• Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

• src/parser/mod.rs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build-test

🔇 Additional comments (6)

src/parser/mod.rs (6)

19-44: Excellent documentation improvement!

The expanded documentation clearly explains the macro's purpose, expectations, and includes a comprehensive example. The documentation follows Rust conventions with /// comments and properly explains the cursor field requirement and handler responsibilities.

---

45-45: Improved macro naming convention.

The new name token_dispatch is more descriptive and follows a clearer naming pattern that indicates what is being dispatched (tokens) rather than the action being performed.

---

46-46: Better parameter naming for clarity.

The parameter names $ctx and $tokens are more descriptive than the previous $state and $token_list, making the macro's interface clearer to users.

---

49-52: Consistent parameter usage throughout macro body.

All references to the renamed parameters have been correctly updated throughout the macro implementation, maintaining functional correctness.

---

219-219: Macro call site correctly updated.

The macro invocation has been properly updated to use the new token_dispatch! name whilst maintaining the same functionality.

---

260-260: Macro call site correctly updated.

The second macro invocation has been properly updated to use the new token_dispatch! name, ensuring consistency across the codebase.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch codex/improve-documentation-for-token_dispatch-macro

---

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