Description
contracts/split/src/events.rs has no module-level documentation. New contributors adding events often use inconsistent symbol naming (e.g. some use symbol_short!, others use Symbol::new). A //! module doc at the top of the file that explains the naming convention, topic layout, and when to use next_seq would reduce inconsistencies.
Acceptance Criteria
Context
- Target file:
contracts/split/src/events.rs
Description
contracts/split/src/events.rshas no module-level documentation. New contributors adding events often use inconsistent symbol naming (e.g. some usesymbol_short!, others useSymbol::new). A//!module doc at the top of the file that explains the naming convention, topic layout, and when to usenext_seqwould reduce inconsistencies.Acceptance Criteria
//! # Event naming conventionmodule-level doc comment at the top ofcontracts/split/src/events.rs(split, <verb>, invoice_id), when to callnext_seq, and when to usesymbol_short!vsSymbol::newcargo docbuilds without warningscargo testpassesContext
contracts/split/src/events.rs