Skip to content

Commit 215bc53

Browse files
committed
fix: enhance documentation with naming conventions for input parameters and update guides to use consistent code examples. Refactor code snippets to utilize the new IExec SDK structure and improve clarity in execution methods. Adjust paths for asset imports in the getting started guide.
1 parent dab17bb commit 215bc53

7 files changed

Lines changed: 486 additions & 603 deletions

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,25 @@ Fork this repository and ensure you're working on the `main` branch:
139139
> - All pull requests are reviewed by our team before being merged
140140
> - Feel free to ask questions in the pull request if you need clarification
141141
142+
### Some conventions
143+
144+
In order to keep the documentation consistent, we have some naming conventions
145+
for input parameters:
146+
147+
- `protectedData`: '0x123abc...',
148+
- `protectedDataAddress`: '0x123abc...',
149+
- `authorizedApp`: '0x456def...',
150+
- `authorizedUser`: '0x789cba...',
151+
- `userAddress`: '0x789cba...',
152+
- `appWhitelist`: '0xba46d6...',
153+
- `owner`: '0xa0c15e...',
154+
- `newOwner`: '0xc5e9f4...',
155+
- `voucherOwner`: '0x5714eB...',
156+
- `renterAddress`: '0x246bdf...'
157+
- `subscriberAddress`: '0x246bdf...'
158+
- `workerpool`: '0xa5de76...'
159+
- `taskId`: '0x7ac398...'
160+
142161
## 🆘 Support
143162

144163
- 📖 [Documentation](https://docs.iex.ec)

0 commit comments

Comments
 (0)