Skip to content

Commit e8a98e5

Browse files
Copilotjosecelano
andcommitted
fix: clippy doc-markdown warnings and format code
- Add backticks to UserOutput, OutputSink, StandardSink in doc comments - Add backticks to Ok(()) in doc comment - Run cargo fmt to format code Co-authored-by: josecelano <[email protected]>
1 parent 21f7884 commit e8a98e5

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

src/presentation/user_output.rs

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1255,10 +1255,7 @@ struct StandardSink {
12551255

12561256
impl StandardSink {
12571257
/// Create a new standard sink with the given writers
1258-
fn new(
1259-
stdout: Box<dyn Write + Send + Sync>,
1260-
stderr: Box<dyn Write + Send + Sync>,
1261-
) -> Self {
1258+
fn new(stdout: Box<dyn Write + Send + Sync>, stderr: Box<dyn Write + Send + Sync>) -> Self {
12621259
Self {
12631260
stdout: StdoutWriter::new(stdout),
12641261
stderr: StderrWriter::new(stderr),
@@ -1527,7 +1524,8 @@ impl UserOutput {
15271524
/// ```
15281525
#[must_use]
15291526
pub fn with_theme(verbosity: VerbosityLevel, theme: Theme) -> Self {
1530-
Self::with_sink(verbosity, Box::new(StandardSink::default_console())).with_theme_applied(theme)
1527+
Self::with_sink(verbosity, Box::new(StandardSink::default_console()))
1528+
.with_theme_applied(theme)
15311529
}
15321530

15331531
/// Create `UserOutput` with a custom sink
@@ -1559,7 +1557,7 @@ impl UserOutput {
15591557
}
15601558
}
15611559

1562-
/// Internal helper to apply theme to an existing UserOutput
1560+
/// Internal helper to apply theme to an existing `UserOutput`
15631561
fn with_theme_applied(mut self, theme: Theme) -> Self {
15641562
self.theme = theme;
15651563
self
@@ -1732,15 +1730,15 @@ impl UserOutput {
17321730

17331731
/// Flush all pending output to stdout and stderr
17341732
///
1735-
/// **Note**: With the OutputSink abstraction, flush behavior depends on the
1736-
/// sink implementation. StandardSink does not support explicit flushing.
1733+
/// **Note**: With the `OutputSink` abstraction, flush behavior depends on the
1734+
/// sink implementation. `StandardSink` does not support explicit flushing.
17371735
/// This method is kept for API compatibility but is currently a no-op.
17381736
///
1739-
/// For StandardSink (default), writes are typically line-buffered by the OS.
1737+
/// For `StandardSink` (default), writes are typically line-buffered by the OS.
17401738
///
17411739
/// # Errors
17421740
///
1743-
/// Currently always returns Ok(()) as flush is not supported through sinks.
1741+
/// Currently always returns `Ok(())` as flush is not supported through sinks.
17441742
///
17451743
/// # Examples
17461744
///
@@ -3148,7 +3146,7 @@ mod tests {
31483146
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Normal),
31493147
sink: Box::new(StandardSink::new(
31503148
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3151-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3149+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
31523150
)),
31533151
formatter_override: Some(formatter),
31543152
};
@@ -3178,7 +3176,7 @@ mod tests {
31783176
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Normal),
31793177
sink: Box::new(StandardSink::new(
31803178
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3181-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3179+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
31823180
)),
31833181
formatter_override: Some(formatter),
31843182
};
@@ -3217,7 +3215,7 @@ mod tests {
32173215
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Normal),
32183216
sink: Box::new(StandardSink::new(
32193217
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3220-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3218+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
32213219
)),
32223220
formatter_override: Some(formatter),
32233221
};
@@ -3247,7 +3245,7 @@ mod tests {
32473245
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Normal),
32483246
sink: Box::new(StandardSink::new(
32493247
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3250-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3248+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
32513249
)),
32523250
formatter_override: Some(formatter),
32533251
};
@@ -3275,7 +3273,7 @@ mod tests {
32753273
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Normal),
32763274
sink: Box::new(StandardSink::new(
32773275
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3278-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3276+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
32793277
)),
32803278
formatter_override: Some(formatter),
32813279
};
@@ -3301,7 +3299,7 @@ mod tests {
33013299
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Quiet),
33023300
sink: Box::new(StandardSink::new(
33033301
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3304-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3302+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
33053303
)),
33063304
formatter_override: Some(formatter),
33073305
};
@@ -3332,7 +3330,7 @@ mod tests {
33323330
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Normal),
33333331
sink: Box::new(StandardSink::new(
33343332
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3335-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3333+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
33363334
)),
33373335
formatter_override: Some(formatter),
33383336
};
@@ -3357,7 +3355,7 @@ mod tests {
33573355
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Normal),
33583356
sink: Box::new(StandardSink::new(
33593357
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3360-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3358+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
33613359
)),
33623360
formatter_override: Some(formatter),
33633361
};
@@ -3388,7 +3386,7 @@ mod tests {
33883386
verbosity_filter: VerbosityFilter::new(VerbosityLevel::Normal),
33893387
sink: Box::new(StandardSink::new(
33903388
Box::new(test_support::TestWriter::new(Arc::clone(&stdout_buffer))),
3391-
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
3389+
Box::new(test_support::TestWriter::new(Arc::clone(&stderr_buffer))),
33923390
)),
33933391
formatter_override: Some(formatter),
33943392
};
@@ -4007,7 +4005,8 @@ mod tests {
40074005
let messages1 = Arc::new(Mutex::new(Vec::new()));
40084006
let messages2 = Arc::new(Mutex::new(Vec::new()));
40094007

4010-
let mut composite = CompositeSink::new(vec![Box::new(MockSink::new(Arc::clone(&messages1)))]);
4008+
let mut composite =
4009+
CompositeSink::new(vec![Box::new(MockSink::new(Arc::clone(&messages1)))]);
40114010

40124011
// Add another sink
40134012
composite.add_sink(Box::new(MockSink::new(Arc::clone(&messages2))));
@@ -4028,7 +4027,8 @@ mod tests {
40284027
#[test]
40294028
fn composite_sink_should_write_multiple_messages() {
40304029
let messages = Arc::new(Mutex::new(Vec::new()));
4031-
let mut composite = CompositeSink::new(vec![Box::new(MockSink::new(Arc::clone(&messages)))]);
4030+
let mut composite =
4031+
CompositeSink::new(vec![Box::new(MockSink::new(Arc::clone(&messages)))]);
40324032

40334033
let theme = Theme::emoji();
40344034

0 commit comments

Comments
 (0)