mirror of
https://github.com/sharkdp/bat.git
synced 2026-10-26 20:16:33 +00:00
Fix doc comments on four Config fields
The use_lessopen, set_terminal_title, strip_ansi and sanitize fields were annotated with // instead of ///, so they were silently missing from the rustdoc output for the public bat::config::Config struct. Every sibling field already uses ///.
This commit is contained in:
1 parent
d9559c69f5
commit
a56bca503b
1 file changed
+4
-4
+4
-4
@@ -98,20 +98,20 @@ pub struct Config<'a> {
|
|||||||
/// cached assets) are not available, assets from the binary will be used instead.
|
/// cached assets) are not available, assets from the binary will be used instead.
|
||||||
pub use_custom_assets: bool,
|
pub use_custom_assets: bool,
|
||||||
|
|
||||||
// Whether or not to use $LESSOPEN if set
|
/// Whether or not to use $LESSOPEN if set
|
||||||
#[cfg(feature = "lessopen")]
|
#[cfg(feature = "lessopen")]
|
||||||
pub use_lessopen: bool,
|
pub use_lessopen: bool,
|
||||||
|
|
||||||
// Whether or not to set terminal title when using a pager
|
/// Whether or not to set terminal title when using a pager
|
||||||
pub set_terminal_title: bool,
|
pub set_terminal_title: bool,
|
||||||
|
|
||||||
/// The maximum number of consecutive empty lines to display
|
/// The maximum number of consecutive empty lines to display
|
||||||
pub squeeze_lines: Option<usize>,
|
pub squeeze_lines: Option<usize>,
|
||||||
|
|
||||||
// Whether or not to strip ANSI escape codes from the input
|
/// Whether or not to strip ANSI escape codes from the input
|
||||||
pub strip_ansi: StripAnsiMode,
|
pub strip_ansi: StripAnsiMode,
|
||||||
|
|
||||||
// Substitute terminal-active and spoofing-relevant bytes; implies strip_ansi.
|
/// Substitute terminal-active and spoofing-relevant bytes; implies strip_ansi.
|
||||||
pub sanitize: StripAnsiMode,
|
pub sanitize: StripAnsiMode,
|
||||||
|
|
||||||
/// Whether or not to produce no output when input is empty
|
/// Whether or not to produce no output when input is empty
|
||||||
|
|||||||
Reference in new issue
Block a user