Skip to content

Commit 5f97fe6

Browse files
committed
docs: Fix some formatting nits
I built this with nightly 2021-05-10 and it said: warning: unresolved link to `e` --> src/currentprocess.rs:30:57 | 30 | /// CurrentProcess and must not be used. That includes [e]println! as well as | ^ no item named `e` in scope | = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` warning: this URL is not a hyperlink --> src/dist/manifest.rs:13:11 | 13 | //! Docs: https://forge.rust-lang.org/infra/channel-layout.html | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://forge.rust-lang.org/infra/channel-layout.html>` | = note: `#[warn(rustdoc::bare_urls)]` on by default = note: bare URLs are not automatically turned into clickable links warning: this URL is not a hyperlink --> src/errors.rs:21:77 | 21 | /// A type erasing thunk for the retry crate to permit use with anyhow. See dtolnay/anyhow#149 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://github.com/dtolnay/anyhow/issues/149>` | = note: bare URLs are not automatically turned into clickable links warning: 3 warnings emitted Finished dev [unoptimized + debuginfo] target(s) in 7.43s nailing-cargo: unnailed. status 0. Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
1 parent e0942b7 commit 5f97fe6

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

src/currentprocess.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ use varsource::*;
2727
/// This provides replacements env::arg*, env::var*, and the standard files
2828
/// io::std* with traits that are customisable for tests. As a result any macros
2929
/// or code that have non-pluggable usage of those are incompatible with
30-
/// CurrentProcess and must not be used. That includes [e]println! as well as
30+
/// CurrentProcess and must not be used. That includes \[e\]println! as well as
3131
/// third party crates.
3232
///
3333
/// CurrentProcess is used via an instance in a thread local variable; when

src/dist/manifest.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
//!
1111
//! See tests/channel-rust-nightly-example.toml for an example.
1212
//!
13-
//! Docs: https://forge.rust-lang.org/infra/channel-layout.html
13+
//! Docs: <https://forge.rust-lang.org/infra/channel-layout.html>
1414
1515
use std::collections::HashMap;
1616
use std::hash::{Hash, Hasher};

src/errors.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ pub const TOOLSTATE_MSG: &str =
1818
Then you can use the toolchain with commands such as:\n\n \
1919
cargo +nightly-2018-12-27 build";
2020

21-
/// A type erasing thunk for the retry crate to permit use with anyhow. See https://github.com/dtolnay/anyhow/issues/149
21+
/// A type erasing thunk for the retry crate to permit use with anyhow. See <https://github.com/dtolnay/anyhow/issues/149>
2222
#[derive(Debug, ThisError)]
2323
#[error(transparent)]
2424
pub struct OperationError(pub anyhow::Error);

0 commit comments

Comments
 (0)