mirror of
https://github.com/sharkdp/bat.git
synced 2024-12-27 00:38:52 +01:00
pretty_printer.rs: Don't use a URL as an example Input title
Otherwise Rust 1.53.0 gets confused during `cargo doc` because it thinks we want an actual URL: warning: this URL is not a hyperlink --> src/pretty_printer.rs:331:40 | 331 | /// The title for the input (e.g. "http://example.com/example.txt") | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<http://example.com/example.txt>` | = note: `#[warn(rustdoc::bare_urls)]` on by default = note: bare URLs are not automatically turned into clickable links It was perhaps also a bit confusing to give an URL as an example in the first place, because according to our own API example `examples/inputs.rs` it is meant to be more a free-text thing.
This commit is contained in:
parent
d3aa17ae77
commit
073b9968c0
@ -328,7 +328,7 @@ impl<'a> Input<'a> {
|
||||
self
|
||||
}
|
||||
|
||||
/// The title for the input (e.g. "http://example.com/example.txt")
|
||||
/// The title for the input (e.g. "Descriptive title")
|
||||
/// This defaults to the file name.
|
||||
pub fn title(mut self, title: impl Into<String>) -> Self {
|
||||
self.input.description_mut().set_title(Some(title.into()));
|
||||
|
Loading…
Reference in New Issue
Block a user