docs: improve documentation

crates/pop-cli/src/commands/call/parachain.rs

@@ -44,7 +44,7 @@ impl CallParachainCommand {
 	/// Executes the command.
 	pub(crate) async fn execute(mut self) -> Result<()> {
 		let mut cli = cli::Cli;
-		// Check if all fields are specified via command line argument.
+		// Check if all fields are specified via the command line.
 		let prompt_to_repeat_call = self.requires_user_input();
 		// Configure the chain.
 		let chain = self.configure_chain(&mut cli).await?;
@@ -207,13 +207,13 @@ impl CallParachainCommand {
 	}
 }
 
-/// Represents a chain, including its URL, client connection, and available pallets.
+// Represents a chain, including its URL, client connection, and available pallets.
 struct Chain {
-	/// Websocket endpoint of the node.
+	// Websocket endpoint of the node.
 	url: Url,
-	/// The client used to interact with the chain.
+	// The client used to interact with the chain.
 	client: OnlineClient<SubstrateConfig>,
-	/// A list of pallets available on the chain.
+	// A list of pallets available on the chain.
 	pallets: Vec<Pallet>,
 }
 

crates/pop-common/src/signer.rs

@@ -4,6 +4,9 @@ use crate::errors::Error;
 use subxt_signer::{sr25519::Keypair, SecretUri};
 
 /// Create a Signer from a secret URI.
+///
+/// # Arguments
+/// `suri` - Secret URI string used to generate the `Keypair`.
 pub fn create_signer(suri: &str) -> Result<Keypair, Error> {
 	let uri = <SecretUri as std::str::FromStr>::from_str(suri)
 		.map_err(|e| Error::ParseSecretURI(format!("{}", e)))?;

crates/pop-parachains/src/call/metadata/action.rs

@@ -105,7 +105,7 @@ impl Action {
 /// Fetch the list of supported actions based on available pallets.
 ///
 /// # Arguments
-/// * `pallets`: List of pallets availables in the chain.
+/// * `pallets`: Supported pallets.
 pub async fn supported_actions(pallets: &[Pallet]) -> Vec<Action> {
 	let mut actions = Vec::new();
 	for action in Action::VARIANTS.iter() {

crates/pop-parachains/src/call/metadata/mod.rs

@@ -26,7 +26,7 @@ impl Display for Pallet {
 	}
 }
 
-/// Represents an extrinsic in a pallet.
+/// Represents an extrinsic.
 #[derive(Clone, PartialEq, Eq, Debug)]
 pub struct Extrinsic {
 	/// The name of the extrinsic.
@@ -49,7 +49,7 @@ impl Display for Extrinsic {
 /// parameters.
 ///
 /// # Arguments
-/// * `client`:`client` - The client used to interact with the chain.
+/// * `client`: The client to interact with the chain.
 pub async fn parse_chain_metadata(
 	client: &OnlineClient<SubstrateConfig>,
 ) -> Result<Vec<Pallet>, Error> {

crates/pop-parachains/src/call/metadata/params.rs

@@ -25,8 +25,8 @@ pub struct Param {
 /// Transforms a metadata field into its `Param` representation.
 ///
 /// # Arguments
-/// * `client`: `client` - The client used to interact with the chain.
-/// * `field`: A reference to a metadata field of the extrinsic.
+/// * `client`: The client to interact with the chain.
+/// * `field`: A parameter of an extrinsic as struct field.
 pub fn field_to_param(
 	client: &OnlineClient<SubstrateConfig>,
 	field: &Field<PortableForm>,
@@ -46,7 +46,7 @@ pub fn field_to_param(
 ///
 /// # Arguments
 /// * `name`: The name of the parameter.
-/// * `registry`: A reference to the `PortableRegistry` to resolve type dependencies.
+/// * `registry`: Type registry containing all types used in the metadata.
 /// * `type_id`: The ID of the type to be converted.
 fn type_to_param(name: String, registry: &PortableRegistry, type_id: u32) -> Result<Param, Error> {
 	let type_info = registry.resolve(type_id).ok_or(Error::MetadataParsingError(name.clone()))?;