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
This commit is contained in:
Jeremy Rubin
2019-02-15 15:32:37 -08:00
committed by Ignotus Peverell
parent ac6ed71abd
commit dc6542d82b
3 changed files with 20 additions and 13 deletions
+5 -1
View File
@@ -102,7 +102,7 @@ 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) => {
@@ -110,6 +110,7 @@ macro_rules! to_u64 {
};
}
/// Macro to clean up u64 unwrapping as u32
#[macro_export]
macro_rules! to_u32 {
($n:expr) => {
@@ -117,6 +118,7 @@ macro_rules! to_u32 {
};
}
/// Macro to clean up u64 unwrapping as usize
#[macro_export]
macro_rules! to_usize {
($n:expr) => {
@@ -124,6 +126,8 @@ macro_rules! to_usize {
};
}
/// Macro to clean up casting to edge type
/// TODO: this macro uses unhygenic data T
#[macro_export]
macro_rules! to_edge {
($n:expr) => {