Pallet dispatchable+storage doc module. (#13341)

* doc-only pallet

* cargo fmt

* generics fix for dispatchables

* use a module instead

* add doc comment warning that the dispatchable functions are generated

* clean up

* fix typo

* hide Instance4-Instance16 from `pallet` module docs

* revamp Instance1-16 comment

* Document storage types

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* fmt

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* remove unused variables

* crate::Call => Call

Co-authored-by: Bastian Köcher <git@kchr.de>

* fix indentation

Co-authored-by: Bastian Köcher <git@kchr.de>

* remove unneeded block

Co-authored-by: Bastian Köcher <git@kchr.de>

* don't need a Vec

Co-authored-by: Bastian Köcher <git@kchr.de>

* add "doc only" to coment

Co-authored-by: Bastian Köcher <git@kchr.de>

* crate::Call => Call

Co-authored-by: Bastian Köcher <git@kchr.de>

* cargo fmt

---------

Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Sam Johnson <sam@durosoft.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Bastian Köcher <git@kchr.de>
Co-authored-by: parity-processbot <>

substrate/frame/support/src/instances.rs

@@ -31,66 +31,83 @@
 //! NOTE: [`frame_support::pallet`] will reexport them inside the module, in order to make them
 //! accessible to [`frame_support::construct_runtime`].
 
-/// Instance1 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance1` to be used for instantiable palllets defined with the
+/// [`#[pallet]`](`frame_support::pallet`) macro. Instances 2-16 are also available but are hidden
+/// from docs.
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance1;
 
-/// Instance2 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance2` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance2;
 
-/// Instance3 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance3` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance3;
 
-/// Instance4 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance4` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance4;
 
-/// Instance5 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance5` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance5;
 
-/// Instance6 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance6` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance6;
 
-/// Instance7 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance7` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance7;
 
-/// Instance8 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance8` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance8;
 
-/// Instance9 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance9` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance9;
 
-/// Instance10 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance10` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance10;
 
-/// Instance11 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance11` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance11;
 
-/// Instance12 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance12` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance12;
 
-/// Instance13 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance13` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance13;
 
-/// Instance14 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance14` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance14;
 
-/// Instance15 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance15` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance15;
 
-/// Instance16 to be used for instantiable pallet define with `pallet` macro.
+/// `Instance16` to be used for instantiable palllets defined with the `#[pallet]` macro.
+#[doc(hidden)]
 #[derive(Clone, Copy, PartialEq, Eq, crate::RuntimeDebugNoBound)]
 pub struct Instance16;