frame/support: Improve documentation

Signed-off-by: Alexandru Vasile <[email protected]>

frame/support/procedural/src/lib.rs

@@ -495,7 +495,7 @@ pub fn construct_runtime(input: TokenStream) -> TokenStream {
 /// #[doc = include_str!("../README.md")]
 /// #[pallet_doc("../doc1.md")]
 /// #[pallet_doc("../doc2.md")]
-/// pub struct Pallet<T>(_);
+/// pub mod pallet {}
 /// ```
 ///
 /// The runtime metadata for this pallet contains the following
@@ -514,7 +514,7 @@ pub fn construct_runtime(input: TokenStream) -> TokenStream {
 /// /// Documentation for pallet 1
 /// /// Documentation for pallet 2
 /// /// Content of README.md
-/// pub struct Pallet<T>(_);
+/// pub mod pallet {}
 /// ```
 ///
 /// If you want to specify the file from which the documentation is loaded, you can use the
@@ -531,7 +531,7 @@ pub fn construct_runtime(input: TokenStream) -> TokenStream {
 ///
 /// This approach is beneficial when you use the `include_str` macro at the beginning of the file
 /// and want that documentation to extend to the runtime metadata, without reiterating the
-/// documentation on the module itself.
+/// documentation on the pallet module itself.
 #[proc_macro_attribute]
 pub fn pallet(attr: TokenStream, item: TokenStream) -> TokenStream {
 	pallet::pallet(attr, item)

frame/support/procedural/src/pallet/expand/documentation.rs

@@ -145,7 +145,7 @@ impl ToTokens for DocMetaValue {
 /// Implement a `pallet_documentation_metadata` function to fetch the
 /// documentation that is included in the metadata.
 ///
-/// The documentation is placed at the top of the module similar to:
+/// The documentation is placed on the pallet similar to:
 ///
 /// ```ignore
 /// #[pallet]
@@ -163,7 +163,7 @@ impl ToTokens for DocMetaValue {
 /// which is the file path that holds the documentation to be added to the metadata.
 ///
 /// Unlike the `doc` attribute, the documentation provided to the `proc_macro` attribute is
-/// not inserted at the beginning of the module.
+/// not added to the pallet.
 pub fn expand_documentation(def: &mut Def) -> proc_macro2::TokenStream {
 	let frame_support = &def.frame_support;
 	let type_impl_gen = &def.type_impl_generics(proc_macro2::Span::call_site());

frame/support/src/metadata_ir/types.rs

@@ -31,7 +31,7 @@ use scale_info::{
 /// When the IR does not contain enough information to generate a specific version
 /// of the runtime metadata an appropriate default value is used (ie, empty vector).
 pub struct MetadataIR<T: Form = MetaForm> {
-	/// Palet metadata.
+	/// Pallet metadata.
 	pub pallets: Vec<PalletMetadataIR<T>>,
 	/// Metadata of the extrinsic.
 	pub extrinsic: ExtrinsicMetadataIR<T>,