📝 Add docstrings to codex/encapsulate-token-utility-functions

[coderabbitai]

Docstrings generation was requested by @leynos.

• Encapsulate token utilities in TokenStream #30 (comment)

The following files were modified:

• src/parser/mod.rs
• src/parser/span_collector.rs
• src/parser/token_stream.rs

These file types are not supported

• docs/ddlint-design-and-road-map.md

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

Summary by Sourcery

Add comprehensive Rust docstrings and inline examples to parser and token utility functions, as well as SpanCollector constructor.

Documentation:

• Add docstrings with examples to parse_tokens, collect_import_spans, and collect_typedef_spans functions
• Document internal handlers for import, typedef, and extern parsing with usage examples
• Add detailed doc comments and examples to TokenStream methods (new, cursor, peek, advance, tokens, src, skip_until, line_end, skip_ws_inline)
• Document SpanCollector::new constructor with parameters and example usage

Tests:

• Include example-based doc comments in existing tests for skip_until, line_end, skip_ws_inline, and out-of-bounds behavior

[sourcery-ai]

Reviewer's Guide

This PR enriches the parser modules with comprehensive Rust doc comments—adding structured descriptions, # Returns and # Examples sections, and inline documentation for helper functions and tests without changing any business logic.

Class diagram for updated parser utility types and methods

classDiagram
    class TokenStream {
        +new(tokens: &[(SyntaxKind, Span)], src: &str) TokenStream
        +cursor() usize
        +peek() Option<(SyntaxKind, Span)>
        +advance()
        +tokens() &[(SyntaxKind, Span)]
        +src() &str
        +skip_until(end: usize)
        +line_end(start: usize) usize
        +skip_ws_inline()
    }

    class SpanCollector {
        +new(tokens: &[(SyntaxKind, Span)], src: &str, extra: Extra) SpanCollector
        spans: Vec<Span>
        stream: TokenStream
        extra: Extra
    }

    TokenStream <.. SpanCollector : used by

Loading

Class diagram for parser utility functions with enhanced docstrings

classDiagram
    class parser {
        +parse(src: &str) Parsed
        +parse_tokens(tokens: &[(SyntaxKind, Span)], src: &str) (Vec<Span>, Vec<Span>, Vec<Simple<SyntaxKind>>)
        +collect_import_spans(tokens: &[(SyntaxKind, Span)], src: &str) (Vec<Span>, Vec<Simple<SyntaxKind>>)
        +collect_typedef_spans(tokens: &[(SyntaxKind, Span)], src: &str) Vec<Span>
    }
    parser ..> TokenStream : uses
    parser ..> SpanCollector : uses

Loading

File-Level Changes

Change	Details	Files
Enhanced documentation in parser entry point and span-collection logic	Added top-level docstring to parse_tokens with return types and example Rewrote and extended docs on collect_import_spans and collect_typedef_spans with # Returns and # Examples Introduced doc comments for nested handlers (handle_import, handle_typedef, handle_extern) Annotated key tests with usage examples for skip_until, line_end, and skip_ws_inline	src/parser/mod.rs
Overhauled documentation for TokenStream API	Provided detailed doc on new, cursor, peek, advance, tokens, and src methods with usage examples Added # Examples and expanded descriptions for skip_until, line_end, and skip_ws_inline Clarified behavior around newline handling and stream boundaries in comments	src/parser/token_stream.rs
Documented SpanCollector construction	Added comprehensive docstring to SpanCollector::new with parameter list, return info, and example usage	src/parser/span_collector.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]

Important

Review skipped

CodeRabbit bot authored PR detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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