Skip to content

Add doc-comments to all ContractError variants explaining when each is returned #698

Description

@Kingsman-99

Description

ContractError has 63 variants but many have no or only partial documentation explaining which entry point returns them and under what condition. Contributors adding new features need clear documentation to understand which error to use, and users need documentation to handle errors correctly.

Acceptance Criteria

  • Every ContractError variant has at least one sentence of doc-comment
  • Doc-comment names the entry point(s) that can return the error
  • Doc-comment describes the specific condition that triggers the error
  • All existing doc-comments are reviewed and updated if incomplete
  • cargo doc --no-deps completes without warnings in contracts/split

Context

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave programcomplexity: highComplex feature requiring deep knowledge - 200 ptsdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions