Skip to content

Move function attributes below doc comments#84

Merged
leynos merged 1 commit intocoderabbitai/docstrings/137Ntpuf3YWgwzqZ2FM447zW0Qa1LGNU6V6phWP1z6BT3qWP8zgIxoQz3chiLpWECvgWKIdqhSxCfrom
codex/move-function-attributes-after-doc-comments
Jun 20, 2025
Merged

Move function attributes below doc comments#84
leynos merged 1 commit intocoderabbitai/docstrings/137Ntpuf3YWgwzqZ2FM447zW0Qa1LGNU6V6phWP1z6BT3qWP8zgIxoQz3chiLpWECvgWKIdqhSxCfrom
codex/move-function-attributes-after-doc-comments

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 20, 2025

Summary

  • reorder attributes after doc comments for consistency
  • fix doctest formatting and run cargo fmt

Testing

  • make lint
  • make test

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

Summary by Sourcery

Standardize the placement of function attributes below doc comments, refine documentation formatting, and run rustfmt for consistent code style

Enhancements:

  • Reorder attributes to follow doc comments for consistent style
  • Adjust doc comment text and formatting for clarity
  • Apply rustfmt to update code formatting

Tests:

  • Wrap and adjust doc comments in tests for line-length consistency

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 20, 2025

Reviewer's Guide

This PR reorders attribute annotations to appear directly below documentation comments across extractor, middleware, and server modules for consistency, refines doc comment phrasing, corrects doctest formatting in tests, and applies rustfmt.

File-Level Changes

Change Details Files
Reordered attribute annotations beneath doc comments in extractor module
  • Moved #[must_use] and #[deprecated] under the doc comment for SharedState::new
  • Repositioned #[must_use] under the doc comment for Message::into_inner
  • Shifted doc comments above attribute annotations in std::ops::Deref implementations for SharedState and Message
  • Reordered #[must_use] under the peer_addr doc comment in ConnectionInfo
src/extractor.rs
Reordered method attributes in middleware and server modules
  • Moved #[inline] and #[must_use] under doc comments for Next::new in middleware
  • Moved #[inline] and #[must_use] under doc comments for WireframeServer::worker_count in server
src/middleware.rs
src/server.rs
Refined documentation phrasing and structure
  • Expanded and clarified the SharedState constructor summary
  • Normalized wording for peer_addr and from_message_request methods
  • Unified method summaries (e.g., into_inner) for a consistent voice
src/extractor.rs
Improved doctest formatting in extractor tests
  • Wrapped long lines in test doc comments to enhance readability
  • Aligned code fences and blank lines within doc comments
  • Ensured consistent line breaks after sentence boundaries
tests/extractor.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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 20, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. 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.

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/move-function-attributes-after-doc-comments

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

@leynos leynos merged commit 01bbe18 into coderabbitai/docstrings/137Ntpuf3YWgwzqZ2FM447zW0Qa1LGNU6V6phWP1z6BT3qWP8zgIxoQz3chiLpWECvgWKIdqhSxC Jun 20, 2025
2 checks passed
@leynos leynos deleted the codex/move-function-attributes-after-doc-comments branch June 20, 2025 00:05
leynos added a commit that referenced this pull request Jun 20, 2025
…erequest` (#83)

* 📝 Add docstrings to `codex/define-extractors-and-implement-frommessagerequest`

Docstrings generation was requested by @leynos.

* #79 (comment)

The following files were modified:

* `src/extractor.rs`
* `tests/extractor.rs`

* Reorder attributes after doc comments (#84)

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Leynos <leynos@troubledskies.net>
leynos added a commit that referenced this pull request Jun 20, 2025
* Update limitation note

* Add extractor class diagram

* Refine extractor docs and tests

* Refine extractor errors and add debug derives

* 📝 Add docstrings to `codex/define-extractors-and-implement-frommessagerequest` (#83)

* 📝 Add docstrings to `codex/define-extractors-and-implement-frommessagerequest`

Docstrings generation was requested by @leynos.

* #79 (comment)

The following files were modified:

* `src/extractor.rs`
* `tests/extractor.rs`

* Reorder attributes after doc comments (#84)

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Leynos <leynos@troubledskies.net>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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