hex-literal: add documentation (#73)

RustCrypto · Aug 2, 2020 · fd86961 · fd86961
1 parent 2cb81e3
commit fd86961
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/hex-literal/CHANGELOG.md b/hex-literal/CHANGELOG.md
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.3.1 (2020-08-01)
+### Added
+- Documentation for the `hex!` macro ([#73])
+
+[#73]: https://github.com/RustCrypto/utils/pull/73
+
 ## 0.3.0 (2020-07-16)
 ### Changed
 - MSRV bump to 1.45 ([#53])

diff --git a/hex-literal/Cargo.toml b/hex-literal/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "hex-literal"
-version = "0.3.0"
+version = "0.3.1"
 authors = ["RustCrypto Developers"]
 license = "MIT OR Apache-2.0"
 description = "Procedural macro for converting hexadecimal string to byte array at compile time."

diff --git a/hex-literal/src/lib.rs b/hex-literal/src/lib.rs
@@ -90,7 +90,7 @@ impl TokenTreeIter {
                 b'A'..=b'F' => v - 55,
                 b'a'..=b'f' => v - 87,
                 b' ' | b'\r' | b'\n' | b'\t' => continue,
-                _ => panic!("invalid character"),
+                _ => panic!("encountered invalid character"),
             };
             return Some(n);
         }
@@ -117,6 +117,8 @@ impl Iterator for TokenTreeIter {
     }
 }
 
+/// Macro for converting string literal containing hex-encoded string
+/// to an array containing decoded bytes
 #[proc_macro]
 pub fn hex(input: TokenStream) -> TokenStream {
     let ts = TokenStream::from_iter(TokenTreeIter::new(input));