Skip to content

docs(admin): add NatSpec documentation for revoke_role - #1

Open
codenerde wants to merge 1 commit into
mainfrom
test56
Open

docs(admin): add NatSpec documentation for revoke_role#1
codenerde wants to merge 1 commit into
mainfrom
test56

Conversation

@codenerde

Copy link
Copy Markdown
Owner

Description

Add comprehensive NatSpec documentation for the revoke_role function in the admin access-control module.

The documentation covers:

  • Summary: explains that only the admin can revoke roles and that un-granted pairs return RoleNotGranted instead of panicking
  • Arguments section: documents env, role, and address parameters
  • Errors section: documents AdminError::RoleNotGranted return
  • Panics section: documents the three panic conditions (uninitialized contract, zero-address sentinel, unauthorized caller)
  • Intra-doc links: uses backtick-linked references to grant_role, Role, and AdminError::RoleNotGranted

Related Issues

Closes BCPathway#491

Checklist

  • Documentation is clear and accurate
  • Linter/Formatter passes with 0 warnings
  • Follows NatSpec standard
  • All tests pass (19/19)

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