From 0eea080b87a7253d1c07e81379d31556d39781a2 Mon Sep 17 00:00:00 2001 From: Nikita Khateev Date: Fri, 8 Dec 2023 15:16:15 +0400 Subject: [PATCH] [19] add block examples and important information --- docs/templates/pallet.adoc | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/templates/pallet.adoc b/docs/templates/pallet.adoc index 3459788..e8bb2e5 100644 --- a/docs/templates/pallet.adoc +++ b/docs/templates/pallet.adoc @@ -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) \ No newline at end of file +* `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.