chore/docs: eliminate warnings (#2583)

* chore: replace trim_right with $ sed -i'' 's/trim_right/trim_end/' **/*.rs * docs: individually document macros to avoid warning, add TODO to make to_edge hygenic * docs: document impl_array_newtype macros, refactor: move all impl_array_newtype macro traits into impl_array_netype_index
mimblewimble · Feb 15, 2019 · dc6542d · dc6542d
1 parent ac6ed71
commit dc6542d
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 13 deletions.
diff --git a/api/src/web.rs b/api/src/web.rs
@@ -142,7 +142,7 @@ impl From<Request<Body>> for QueryParams {
 #[macro_export]
 macro_rules! right_path_element(
 	($req: expr) =>(
-		match $req.uri().path().trim_right_matches('/').rsplit('/').next() {
+		match $req.uri().path().trim_end_matches('/').rsplit('/').next() {
 			None => return response(StatusCode::BAD_REQUEST, "invalid url"),
 			Some(el) => el,
 		};

diff --git a/core/src/pow/common.rs b/core/src/pow/common.rs
@@ -102,28 +102,32 @@ pub fn create_siphash_keys(header: &[u8]) -> Result<[u64; 4], Error> {
 	])
 }
 
-/// Macros to clean up integer unwrapping
+/// Macro to clean up u64 unwrapping
 #[macro_export]
 macro_rules! to_u64 {
 	($n:expr) => {
 		$n.to_u64().ok_or(ErrorKind::IntegerCast)?
 	};
 }
 
+/// Macro to clean up u64 unwrapping as u32
 #[macro_export]
 macro_rules! to_u32 {
 	($n:expr) => {
 		$n.to_u64().ok_or(ErrorKind::IntegerCast)? as u32
 	};
 }
 
+/// Macro to clean up u64 unwrapping as usize
 #[macro_export]
 macro_rules! to_usize {
 	($n:expr) => {
 		$n.to_u64().ok_or(ErrorKind::IntegerCast)? as usize
 	};
 }
 
+/// Macro to clean up casting to edge type
+/// TODO: this macro uses unhygenic data T
 #[macro_export]
 macro_rules! to_edge {
 	($n:expr) => {

diff --git a/util/src/macros.rs b/util/src/macros.rs
@@ -28,6 +28,7 @@
 
 //! Macros to support Rust BIP-32 code (though could conceivably be used for other things)
 
+/// gives a newtype array wrapper standard array traits
 #[macro_export]
 macro_rules! impl_array_newtype {
 	($thing:ident, $ty:ty, $len:expr) => {
@@ -86,16 +87,6 @@ macro_rules! impl_array_newtype {
 			}
 		}
 
-		impl ::std::ops::Index<usize> for $thing {
-			type Output = $ty;
-
-			#[inline]
-			fn index(&self, index: usize) -> &$ty {
-				let &$thing(ref dat) = self;
-				&dat[index]
-			}
-		}
-
 		impl_index_newtype!($thing, $ty);
 
 		impl PartialEq for $thing {
@@ -164,6 +155,7 @@ macro_rules! impl_array_newtype {
 	};
 }
 
+/// gives a newtype array wrapper serialization and deserialization methods
 #[macro_export]
 macro_rules! impl_array_newtype_encodable {
 	($thing:ident, $ty:ty, $len:expr) => {
@@ -193,7 +185,7 @@ macro_rules! impl_array_newtype_encodable {
 							*item = match seq.next_element()? {
 								Some(c) => c,
 								None => {
-									return Err($crate::serde::de::Error::custom("end of stream"))
+									return Err($crate::serde::de::Error::custom("end of stream"));
 								}
 							};
 						}
@@ -218,6 +210,7 @@ macro_rules! impl_array_newtype_encodable {
 	};
 }
 
+/// gives a newtype array wrapper the Debug trait
 #[macro_export]
 macro_rules! impl_array_newtype_show {
 	($thing:ident) => {
@@ -229,9 +222,19 @@ macro_rules! impl_array_newtype_show {
 	};
 }
 
+/// gives a newtype array wrapper Index traits
 #[macro_export]
 macro_rules! impl_index_newtype {
 	($thing:ident, $ty:ty) => {
+		impl ::std::ops::Index<usize> for $thing {
+			type Output = $ty;
+
+			#[inline]
+			fn index(&self, index: usize) -> &$ty {
+				let &$thing(ref dat) = self;
+				&dat[index]
+			}
+		}
 		impl ::std::ops::Index<::std::ops::Range<usize>> for $thing {
 			type Output = [$ty];