From c7dbddc9ed11693b14173c0d443eb86ce45a6fcb Mon Sep 17 00:00:00 2001 From: Alex Pyrgiotis Date: Mon, 21 Jun 2021 19:30:09 +0000 Subject: [PATCH] metadata: Fix some rustdoc::bare_urls warnings Fix some rustdoc::bare_urls warnings that appeared due to a rustdoc lint [1] that was recently introduced in stable Rust [2]. By default, bare URLs trigger a warning, and the developer must decide if they want to render them as hyperlinks or as literal values. In our case, we have two URLs in our footnotes that we want to render as hyperlinks, so we enclose them in <...>. [1]: https://doc.rust-lang.org/rustdoc/lints.html#bare_urls [2]: https://github.com/rust-lang/rust/pull/81764 --- CHANGELOG.md | 6 ++++++ src/metadata.rs | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 50e254a..9d26635 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ Versioning]. ## [Unreleased] +### Fixed + +- Fix a `rustdoc::bare_urls` warning for some links that we used in our + footnotes and did not have any style indication, by formatting them as + hyperliks. + ## [0.3.1] - 2021-04-20 ### Fixed diff --git a/src/metadata.rs b/src/metadata.rs index e49d383..784bc3e 100644 --- a/src/metadata.rs +++ b/src/metadata.rs @@ -90,7 +90,7 @@ use protobuf::Message; /// recommended size by IETF [^ietf], and because the Ring library does not /// accept any other size. /// -/// [^ietf]: From https://tools.ietf.org/html/rfc5084#section-3.2: +/// [^ietf]: From : /// _A length of 12 octets is RECOMMENDED._ pub const RING_NONCE_SIZE: usize = 12; @@ -129,7 +129,7 @@ pub const PBKDF2_DEFAULT_ITERATIONS: usize = 100000; /// because it's generally better if the output of the HMAC function matches /// the length of the desired key [^pbkdf2-design-flaw]. /// -/// [^pbkdf2-design-flaw]: https://www.chosenplaintext.ca/2015/10/08/pbkdf2-design-flaw.html +/// [^pbkdf2-design-flaw]: pub const PBKDF2_DEFAULT_HASH_FN: HashFunction = HashFunction::SHA256; /// The hash functions that this library supports.