-
Notifications
You must be signed in to change notification settings - Fork 7
Description
-
All the examples in the Cookbook are under the "Basics" category. Since there is only one category, it is not very informative. Maybe a better classification would be to arrange the examples related to the following categories:
- Statements
- Slices and cells
- Data structures (dictionaries, tuples, lists)
- Internal messages
- Contracts
- Addresses
- Functions (asm, modifying methods)
- Integer utilities
- String utilities
- Errors
-
All examples need to provide code comments: they should describe what each line does and what the variables represent. Also, all examples should provide code comments describing expected values of variables (whenever possible). This is necessary so that users can follow the code without the need to run it. Why? Because these examples are meant to be compact pieces of code that can be reutilized; as such, they need to be readable and understandable without the need to execute them.
PENDING: Check that each example actually executes and does what it claims it does.