Skip to content

Expand OverflowBehavior and OverfundingPolicy docs to explain their relationship #631

Description

@Kingsman-99

Description

Both OverflowBehavior and OverfundingPolicy appear in contracts/split/src/types.rs and govern overpayment handling. Their relationship is subtle (OverfundingPolicy::Cap delegates to OverflowBehavior). The existing comments are brief; expanding them with a # Relationship section explaining which takes precedence would prevent misuse.

Acceptance Criteria

  • Add an expanded doc comment to both OverflowBehavior and OverfundingPolicy in contracts/split/src/types.rs
  • The comment for OverfundingPolicy::Cap explains it delegates to OverflowBehavior
  • The comment for OverfundingPolicy includes a # Relationship section referencing OverflowBehavior
  • cargo doc builds without warnings
  • cargo test passes

Context

  • Target file: contracts/split/src/types.rs

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programcomplexity: highComplex feature requiring deep knowledge - 200 ptsrefactorCode quality and restructuring

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions