Skip to content

Commit d480557

Browse files
committed
Add a note to README about adding exclusions
1 parent 951f1f7 commit d480557

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,10 @@ The generated Python bindings include the contract ABIs as Python dictionaries.
144144
If there is a new contract to include, add a new target to `Makefile` and a new
145145
factory function to `autonity/factory.py` and `autonity/__init__.py`.
146146

147+
If an external/public function has an `only*` modifier that restricts usage by
148+
end-users, then add an exclusion in the Makefile. Examples of such modifiers are
149+
`onlyAutonity`, `onlyProtocol`, `onlyAccountability`, `onlyStabilizer`, etc.
150+
147151
## Contributing
148152

149153
To contribute a non-critical bug fix, please open a pull request against the

0 commit comments

Comments
 (0)