search

OpenZeppelin / cairo-contracts

OpenZeppelin Contracts written in Cairo for Starknet, a decentralized ZK Rollup
https://docs.openzeppelin.com/contracts-cairo
MIT License
813 stars 327 forks source link

Consider documenting asserts/guards separately #745

Open martriay opened 1 year ago

martriay commented 1 year ago

Currently there's many guard functions (e.g. assert_only_owner, assert_only_role, etc) analogous to solidity modifiers.

Currently they're documented as simple internals, evaluate if there's value in grouping them in the API docs in their own category.

martriay commented 1 year ago

i think either way they should be under internals since they share the same overall status: they're not externals. maybe they can have their own subgroup as impls do in externals.