Skip to content

Commit 2e0fd1d

Browse files
committed
metadata: Fix some rustdoc::bare_urls warnings
Fix some `rustdoc::bare_urls`` warnings, due to a `rustdoc` lint that was recently introduced in stable Rust [1]. By default, bare URLs trigger a warning and the developer must decide if they want to render them as links, 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]: rust-lang/rust#81764
1 parent dd55d71 commit 2e0fd1d

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ Versioning].
77

88
## [Unreleased]
99

10+
### Fixed
11+
12+
- Fix a `rustdoc::bare_urls`` warning for some links that we used in our
13+
footnotes and did not have any style indication, by formatting them as
14+
hyperliks.
15+
1016
## [0.3.1] - 2021-04-20
1117

1218
### Fixed

src/metadata.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ use protobuf::Message;
9090
/// recommended size by IETF [^ietf], and because the Ring library does not
9191
/// accept any other size.
9292
///
93-
/// [^ietf]: From https://tools.ietf.org/html/rfc5084#section-3.2:
93+
/// [^ietf]: From <https://tools.ietf.org/html/rfc5084#section-3.2>:
9494
/// _A length of 12 octets is RECOMMENDED._
9595
pub const RING_NONCE_SIZE: usize = 12;
9696

@@ -129,7 +129,7 @@ pub const PBKDF2_DEFAULT_ITERATIONS: usize = 100000;
129129
/// because it's generally better if the output of the HMAC function matches
130130
/// the length of the desired key [^pbkdf2-design-flaw].
131131
///
132-
/// [^pbkdf2-design-flaw]: https://www.chosenplaintext.ca/2015/10/08/pbkdf2-design-flaw.html
132+
/// [^pbkdf2-design-flaw]: <https://www.chosenplaintext.ca/2015/10/08/pbkdf2-design-flaw.html>
133133
pub const PBKDF2_DEFAULT_HASH_FN: HashFunction = HashFunction::SHA256;
134134

135135
/// The hash functions that this library supports.

0 commit comments

Comments
 (0)