Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Doc📝] Put type doc comments before derives in resource_budget/limit.rs

Aperta Adatta ai principianti
#10,941 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
95/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

Apri rocketmq-runtime/src/resource_budget/limit.rs e ispeziona i sei tipi elencati: FullPolicy, BudgetClass, BudgetDimension, RateLimit, BudgetCapacity e BudgetLimit. Sposta ogni blocco di documentazione completo esistente sopra il relativo attributo derive senza modificare il testo né i Traits. Dalla radice del repository, esegui cargo fmt -p rocketmq-runtime -- --check e cargo doc -p rocketmq-runtime --no-deps; l'operazione è completata quando tutti e sei i blocchi precedono i rispettivi derives e non sono state apportate modifiche non correlate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Difficulty level/Easy documentation📝 good first issue help wanted rust
Issue Type

Improvement suggestion

Location

File: rocketmq-runtime/src/resource_budget/limit.rs (currently lines 19-112).

Types: FullPolicy, BudgetClass, BudgetDimension, RateLimit, BudgetCapacity, BudgetLimit.

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, Clone, Copy, PartialEq, Eq)]
/// Identifies the full policy state.
pub enum FullPolicy {

to:

/// Identifies the full policy state.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum FullPolicy {

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

Acceptance criteria:

  • All 6 listed type documentation blocks appear before their derive attributes in rocketmq-runtime/src/resource_budget/limit.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
Lingua principale
Rust
Stelle
1.5k
Fork
264
Merge medio
2h 27m
PR unite (30g)
547

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di mxsm/rocketmq-rust

Tutte le issue di mxsm/rocketmq-rust

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.