Skip to content

[Doc📝] Put type doc comments before derives in resource_budget/clock.rs #10940

Closed

Description

@mxsm

Issue Type

Improvement suggestion

Location

File: rocketmq-runtime/src/resource_budget/clock.rs (currently lines 27-29).

Types: SystemMonotonicClock.

Description

The listed type documentation blocks currently appear immediately after their #[derive(...)] attributes. Move each complete /// block above the derive attached to that type so the documentation comes first.

This is a single-file task in the rocketmq-runtime crate. Keep the existing documentation text and attribute lists unchanged.

Suggested Fix

For each type listed above, change the order from:

#[derive(Debug)]
/// Represents system monotonic clock.
pub struct SystemMonotonicClock {

to:

/// Represents system monotonic clock.
#[derive(Debug)]
pub struct SystemMonotonicClock {

The snippet illustrates the ordering using SystemMonotonicClock; retain each actual type's own derive and entire comment block.

Acceptance criteria:

  • The listed type documentation block appears before its derive attribute in rocketmq-runtime/src/resource_budget/clock.rs.
  • No unrelated documentation, derive traits, fields, public APIs, or runtime behavior changes.
  • From the repository root, run cargo fmt -p rocketmq-runtime -- --check and cargo doc -p rocketmq-runtime --no-deps.

Willing to contribute?

  • I can submit a PR for this

Activity

  1. added a commit that references this issue on Sep 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions