[19] add block examples and important information

This commit is contained in:
Nikita Khateev
2023-12-08 15:16:15 +04:00
parent 48b6ed1ab8
commit 0eea080b87
+17 -3
View File
@@ -17,16 +17,26 @@ This is a freeform description of the tasks that this pallet fulfills
== Dispatchables == Dispatchables
[.contract]
[[dispatchable_name]] [[dispatchable_name]]
=== `++dispatchable_name++` link:https://google.com[{github-icon},role=heading-link] === `++dispatchable_name++` link:https://google.com[{github-icon},role=heading-link]
```rust [source,rust]
----
pub fn dispatchable_name( pub fn dispatchable_name(
param1: Type1, param1: Type1,
param2: Type2 param2: Type2
) -> DispatchResult ) -> DispatchResult
``` ----
Freeform description of the dispatchable. It is good to include the important things that should be included there. Freeform description of the dispatchable. It is good to include the important things that should be included there.
NOTE: This is how you state important information that should be acknowledged
IMPORTANT: This is how you put some information that should not be missed
WARNING: This thing is for important information missing which may lead to dangerous consequences
TIP: This is how you should give some useful advice
**Params:** **Params:**
* `param1: Type1` -- description of the parameter * `param1: Type1` -- description of the parameter
@@ -37,4 +47,8 @@ Freeform description of the dispatchable. It is good to include the important th
**Events:** **Events:**
* `EventName(param1, param2)` -- description of event, if needed (they are often self-explanatory) * `EventName(param1, param2)` -- description of event, if needed (they are often self-explanatory)
== Important Mentions and FAQ's
Here you may put a freeform information about any aspect of the pallet.