update docs in binary_sv2 derive_codec

Author: Shourya742

protocols/v2/binary-sv2/derive_codec/src/lib.rs

@@ -56,7 +56,7 @@ use alloc::{
 use core::iter::FromIterator;
 use proc_macro::{Group, TokenStream, TokenTree};
 
-/// Reserved field names to avoid conflicts
+// Reserved field names to avoid conflicts
 const RESERVED_FIELDS: [&str; 2] = ["__decodable_internal_data", "__decodable_internal_offset"];
 
 // Checks if a `TokenStream` contains a group with a bracket delimiter (`[]`),
@@ -494,38 +494,38 @@ fn parse_struct_fields(group: Vec<TokenTree>) -> Vec<ParsedField> {
 ///     }
 ///
 ///     impl<'decoder> Decodable<'decoder> for Test {
-///         fn get_structure(data: &[u8]) -> Result<Vec<FieldMarker>, Error> {
+///         fn get_structure(__decodable_internal_data: &[u8]) -> Result<Vec<FieldMarker>, Error> {
 ///             let mut fields = Vec::new();
-///             let mut offset = 0;
+///             let mut __decodable_internal_offset = 0;
 ///
-///             let a: Vec<FieldMarker> = u32::get_structure(&data[offset..])?;
-///             offset += a.size_hint_(&data, offset)?;
+///             let a: Vec<FieldMarker> = u32::get_structure(&__decodable_internal_data[__decodable_internal_offset..])?;
+///             __decodable_internal_offset += a.size_hint_(&__decodable_internal_data, __decodable_internal_offset)?;
 ///             let a = a.try_into()?;
 ///             fields.push(a);
 ///
-///             let b: Vec<FieldMarker> = u8::get_structure(&data[offset..])?;
-///             offset += b.size_hint_(&data, offset)?;
+///             let b: Vec<FieldMarker> = u8::get_structure(&__decodable_internal_data[__decodable_internal_offset..])?;
+///             __decodable_internal_offset += b.size_hint_(&__decodable_internal_data, __decodable_internal_offset)?;
 ///             let b = b.try_into()?;
 ///             fields.push(b);
 ///
-///             let c: Vec<FieldMarker> = U24::get_structure(&data[offset..])?;
-///             offset += c.size_hint_(&data, offset)?;
+///             let c: Vec<FieldMarker> = U24::get_structure(&__decodable_internal_data[__decodable_internal_offset..])?;
+///             __decodable_internal_offset += c.size_hint_(&__decodable_internal_data, __decodable_internal_offset)?;
 ///             let c = c.try_into()?;
 ///             fields.push(c);
 ///
 ///             Ok(fields)
 ///         }
 ///
-///         fn from_decoded_fields(mut data: Vec<DecodableField<'decoder>>) -> Result<Self, Error> {
+///         fn from_decoded_fields(mut __decodable_internal_data: Vec<DecodableField<'decoder>>) -> Result<Self, Error> {
 ///             Ok(Self {
 ///                 c: U24::from_decoded_fields(
-///                     data.pop().ok_or(Error::NoDecodableFieldPassed)?.into(),
+///                     __decodable_internal_data.pop().ok_or(Error::NoDecodableFieldPassed)?.into(),
 ///                 )?,
 ///                 b: u8::from_decoded_fields(
-///                     data.pop().ok_or(Error::NoDecodableFieldPassed)?.into(),
+///                     __decodable_internal_data.pop().ok_or(Error::NoDecodableFieldPassed)?.into(),
 ///                 )?,
 ///                 a: u32::from_decoded_fields(
-///                     data.pop().ok_or(Error::NoDecodableFieldPassed)?.into(),
+///                     __decodable_internal_data.pop().ok_or(Error::NoDecodableFieldPassed)?.into(),
 ///                 )?,
 ///             })
 ///         }