Skip to content

Commit 537c6fd

Browse files
committed
hex-literal: tweak crate description
1 parent 179070d commit 537c6fd

File tree

4 files changed

+7
-6
lines changed

4 files changed

+7
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This repository contains various utility crates used in the RustCrypto project.
1717
| [`collectable`] | [![crates.io](https://img.shields.io/crates/v/collectable.svg)](https://crates.io/crates/collectable) | [![Documentation](https://docs.rs/collectable/badge.svg)](https://docs.rs/collectable) | Fallible, `no_std`-friendly collection traits |
1818
| [`cpufeatures`] | [![crates.io](https://img.shields.io/crates/v/cpufeatures.svg)](https://crates.io/crates/cpufeatures) | [![Documentation](https://docs.rs/cpufeatures/badge.svg)](https://docs.rs/cpufeatures) | Lightweight and efficient alternative to the `is_x86_feature_detected!` macro |
1919
| [`dbl`] | [![crates.io](https://img.shields.io/crates/v/dbl.svg)](https://crates.io/crates/dbl) | [![Documentation](https://docs.rs/dbl/badge.svg)](https://docs.rs/dbl) | Double operation in Galois Field (GF) |
20-
| [`hex-literal`] | [![crates.io](https://img.shields.io/crates/v/hex-literal.svg)](https://crates.io/crates/hex-literal) | [![Documentation](https://docs.rs/hex-literal/badge.svg)](https://docs.rs/hex-literal) | Procedural macro for converting hexadecimal string to byte array at compile time |
20+
| [`hex-literal`] | [![crates.io](https://img.shields.io/crates/v/hex-literal.svg)](https://crates.io/crates/hex-literal) | [![Documentation](https://docs.rs/hex-literal/badge.svg)](https://docs.rs/hex-literal) | A macro for converting hexadecimal strings to a byte array at compile time |
2121
| [`inout`] | [![crates.io](https://img.shields.io/crates/v/inout.svg)](https://crates.io/crates/inout) | [![Documentation](https://docs.rs/inout/badge.svg)](https://docs.rs/inout) | Custom reference types for code generic over in-place and buffer-to-buffer modes of operation. |
2222
| [`opaque-debug`] | [![crates.io](https://img.shields.io/crates/v/opaque-debug.svg)](https://crates.io/crates/opaque-debug) | [![Documentation](https://docs.rs/opaque-debug/badge.svg)](https://docs.rs/opaque-debug) | Macro for opaque `Debug` trait implementation |
2323
| [`wycheproof2blb`] | | | | Utility for converting [Wycheproof] test vectors to the blobby format |

hex-literal/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "hex-literal"
33
version = "1.0.0"
44
authors = ["RustCrypto Developers"]
55
license = "MIT OR Apache-2.0"
6-
description = "Macro for converting hexadecimal string to a byte array at compile time"
6+
description = "A macro for converting hexadecimal string literals to a byte array at compile time"
77
documentation = "https://docs.rs/hex-literal"
88
repository = "https://github.com/RustCrypto/utils"
99
keywords = ["hex", "literals"]

hex-literal/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
![MSRV][rustc-image]
77
[![Build Status][build-image]][build-link]
88

9-
This crate provides the `hex!` macro for converting hexadecimal string literals to a byte array at compile time.
9+
This crate provides the `hex!` macro for converting a sequence of hexadecimal string literals to a byte array at compile time.
1010

11-
It accepts the following characters in the input string:
11+
The macro accepts the following characters in input string literals:
1212

1313
- `'0'...'9'`, `'a'...'f'`, `'A'...'F'` — hex characters which will be used in construction of the output byte array
1414
- `' '`, `'\r'`, `'\n'`, `'\t'` — formatting characters which will be ignored

hex-literal/src/lib.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,9 @@ pub const fn decode<const LEN: usize>(strings: &[&[u8]]) -> Option<[u8; LEN]> {
7474
if LEN == buf_pos { Some(buf) } else { None }
7575
}
7676

77-
/// Macro for converting sequence of string literals containing hex-encoded data
78-
/// into an array of bytes.
77+
/// Converts a sequence of hexadecimal string literals to a byte array at compile time.
78+
///
79+
/// See the crate-level docs for more information.
7980
#[macro_export]
8081
macro_rules! hex {
8182
($($s:literal)*) => {{

0 commit comments

Comments
 (0)