doc length (#49)

Author: rtso

rust/sdk-examples/src/config/processor_config.rs

@@ -1,5 +1,6 @@
 use serde::{Deserialize, Serialize};
 
+#[allow(clippy::too_long_first_doc_paragraph)]
 /// This enum captures the configs for all the different processors that are defined.
 /// The configs for each processor should only contain configuration specific to that
 /// processor. For configuration that is common to all processors, put it in

rust/sdk-examples/src/utils/database.rs

@@ -34,6 +34,7 @@ pub const MIGRATIONS: EmbeddedMigrations = embed_migrations!("src/db/postgres/mi
 pub const DEFAULT_MAX_POOL_SIZE: u32 = 150;
 
 #[derive(QueryId)]
+#[allow(clippy::too_long_first_doc_paragraph)]
 /// Using this will append a where clause at the end of the string upsert function, e.g.
 /// INSERT INTO ... ON CONFLICT DO UPDATE SET ... WHERE "transaction_version" = excluded."transaction_version"
 /// This is needed when we want to maintain a table with only the latest state
@@ -195,6 +196,7 @@ where
         })
 }
 
+#[allow(clippy::too_long_first_doc_paragraph)]
 /// Returns the entry for the config hashmap, or the default field count for the insert
 /// Given diesel has a limit of how many parameters can be inserted in a single operation (u16::MAX),
 /// we default to chunk an array of items based on how many columns are in the table.

rust/sdk/src/traits/processable.rs

@@ -5,7 +5,7 @@ use crate::{
 use anyhow::Result;
 use async_trait::async_trait;
 
-/// A trait to convince the compiler that different step types are mutually exclusive
+/// Trait to convince the compiler that different step types are mutually exclusive
 pub trait RunnableStepType {}
 
 // This is a dummy implementation for the unit type

rust/sdk/src/traits/runnable_step.rs

@@ -9,6 +9,7 @@ where
     Input: Send + 'static,
     Output: Send + 'static,
 {
+    #[allow(clippy::too_long_first_doc_paragraph)]
     /// Runs the step, forever, with the given input receiver and returns the output receiver and the join handle.
     fn spawn(
         self,
@@ -62,6 +63,7 @@ where
         }
     }
 
+    #[allow(clippy::too_long_first_doc_paragraph)]
     /// This should only be used for the inputless first step to keep the async sender in scope so the channel stays alive.
     pub fn add_input_sender(
         mut self,

rust/sdk/src/types/transaction_context.rs

@@ -1,8 +1,10 @@
 use aptos_indexer_transaction_stream::utils::timestamp_to_unixtime;
 
-/// TransactionContext is a struct that holds data processed from a set of transactions
-/// and includes metadata about the transactions that the data is associated with.
-/// The metadata is used for metrics and logging purposes.
+/// Contains processed data and associated transaction metadata.
+///
+/// The processed data is extracted from transactions and the
+/// TransactionContext contains additional metadata about which transactions the extracted
+/// data originated from. The metadata is used for metrics and logging purposes.
 #[derive(Clone, Default)]
 pub struct TransactionContext<T> {
     pub data: Vec<T>,

rust/sdk/src/utils/convert.rs

@@ -10,8 +10,8 @@ use serde_json::Value;
 use std::str::FromStr;
 use tiny_keccak::{Hasher, Sha3};
 
-/// Standardizes an address / table handle to be a string with length 66 (0x+64 length
-/// hex string).
+#[allow(clippy::too_long_first_doc_paragraph)]
+/// Standardizes an address / table handle to be a string with length 66 (0x+64 length hex string).
 pub fn standardize_address(handle: &str) -> String {
     if let Some(handle) = handle.strip_prefix("0x") {
         format!("0x{:0>64}", handle)
@@ -20,8 +20,8 @@ pub fn standardize_address(handle: &str) -> String {
     }
 }
 
-/// Standardizes an address / table handle to be a string with length 66 (0x+64 length
-/// hex string).
+#[allow(clippy::too_long_first_doc_paragraph)]
+/// Standardizes an address / table handle to be a string with length 66 (0x+64 length hex string).
 pub fn standardize_address_from_bytes(bytes: &[u8]) -> String {
     let encoded_bytes = hex::encode(bytes);
     standardize_address(&encoded_bytes)

rust/sdk/src/utils/extract.rs

@@ -102,9 +102,10 @@ pub fn get_payload_type(payload: &TransactionPayload) -> String {
     payload.r#type().as_str_name().to_string()
 }
 
-/// Part of the json comes escaped from the protobuf so we need to unescape in a safe way
-/// This function converts the string into json recursively and lets the diesel ORM handles
-/// the escaping.
+#[allow(clippy::too_long_first_doc_paragraph)]
+/// Part of the json comes escaped from the protobuf so we need to unescape in a safe way.
+/// This function converts the string into json recursively
+/// and lets the diesel ORM handles the escaping.
 pub fn get_clean_payload(payload: &TransactionPayload, version: i64) -> Option<Value> {
     if payload.payload.as_ref().is_none() {
         // PROCESSOR_UNKNOWN_TYPE_COUNT
@@ -167,8 +168,9 @@ pub fn get_clean_payload(payload: &TransactionPayload, version: i64) -> Option<V
     }
 }
 
-/// Part of the json comes escaped from the protobuf so we need to unescape in a safe way
-/// Note that DirectWriteSet is just events + writeset which is already represented separately
+#[allow(clippy::too_long_first_doc_paragraph)]
+/// Part of the json comes escaped from the protobuf so we need to unescape in a safe way.
+/// /// Note that DirectWriteSet is just events + writeset which is already represented separately
 pub fn get_clean_writeset(writeset: &WriteSet, version: i64) -> Option<Value> {
     match writeset.write_set.as_ref().unwrap() {
         WriteSetType::ScriptWriteSet(inner) => {
@@ -186,6 +188,7 @@ pub fn get_clean_writeset(writeset: &WriteSet, version: i64) -> Option<Value> {
     }
 }
 
+#[allow(clippy::too_long_first_doc_paragraph)]
 /// Part of the json comes escaped from the protobuf so we need to unescape in a safe way
 fn get_clean_entry_function_payload(
     payload: &EntryFunctionPayload,
@@ -207,7 +210,8 @@ fn get_clean_entry_function_payload(
     }
 }
 
-/// Part of the json comes escaped from the protobuf so we need to unescape in a safe way
+/// Part of the json comes escaped from the protobuf
+/// so we need to unescape in a safe way
 fn get_clean_script_payload(payload: &ScriptPayload, version: i64) -> ScriptPayloadClean {
     ScriptPayloadClean {
         code: payload.code.clone(),