Skip to content

docs(admin): add NatSpec for Role enum - #614

Open
codenerde wants to merge 2 commits into
BCPathway:mainfrom
codenerde:test99
Open

docs(admin): add NatSpec for Role enum#614
codenerde wants to merge 2 commits into
BCPathway:mainfrom
codenerde:test99

Conversation

@codenerde

Copy link
Copy Markdown

Summary

Adds comprehensive NatSpec documentation to the Role enum in contracts/admin/src/lib.rs.

Changes

  • Added detailed enum-level documentation with:
    • Summary of the access-control model
    • Variant table with privilege levels and typical use cases
    • Storage invariant warning about variant ordering
    • Cross-references to related functions
  • Enhanced individual variant docs with:
    • Admin: Documents implicit all-role grant and admin-only revoke/grant
    • Minter: Clarifies minting scope and what it doesn't imply
    • SuperAdmin: Explains reserved use cases and security recommendations
    • Pauser: Describes pause semantics and incident response context

Testing

  • cargo fmt --check passes (0 issues)
  • cargo clippy -- -D warnings passes (0 warnings)

Closes #489

@drips-wave

drips-wave Bot commented Jul 29, 2026

Copy link
Copy Markdown

@codenerde Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@p3ris0n

p3ris0n commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

@codenerde fix the conflict please

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs & Polish] Write NatSpec for Role Enum

2 participants