Skip to content

docs(admin): add NatSpec for revoke_role function - #613

Open
codenerde wants to merge 1 commit into
BCPathway:mainfrom
codenerde:docs/natspec-revoke-role
Open

docs(admin): add NatSpec for revoke_role function#613
codenerde wants to merge 1 commit into
BCPathway:mainfrom
codenerde:docs/natspec-revoke-role

Conversation

@codenerde

Copy link
Copy Markdown

Summary

Adds comprehensive NatSpec documentation to the
evoke_role function in contracts/admin/src/lib.rs.

Changes

  • Added # Authorization section documenting admin auth requirement
  • Added # Arguments section with parameter descriptions and constraints
  • Added # Errors section documenting AdminError::RoleNotGranted
  • Added # Events section documenting
    ole_rvk event emission
  • Added # Examples section with usage example

Testing

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

Closes #491

@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 please the conflict

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 revoke_role

2 participants