mirror of
https://github.com/pezkuwichain/pezkuwi-runtime-templates.git
synced 2026-06-09 20:11:03 +00:00
[19] add block examples and important information
This commit is contained in:
Vendored
+17
-3
@@ -17,16 +17,26 @@ This is a freeform description of the tasks that this pallet fulfills
|
||||
|
||||
== Dispatchables
|
||||
|
||||
[.contract]
|
||||
[[dispatchable_name]]
|
||||
=== `++dispatchable_name++` link:https://google.com[{github-icon},role=heading-link]
|
||||
```rust
|
||||
[source,rust]
|
||||
----
|
||||
pub fn dispatchable_name(
|
||||
param1: Type1,
|
||||
param2: Type2
|
||||
) -> DispatchResult
|
||||
```
|
||||
----
|
||||
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:**
|
||||
|
||||
* `param1: Type1` -- description of the parameter
|
||||
@@ -37,4 +47,8 @@ Freeform description of the dispatchable. It is good to include the important th
|
||||
|
||||
**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.
|
||||
|
||||
Reference in New Issue
Block a user