Skip to content

Commit 69e7310

Browse files
committed
Remove unnecessary main function from doctests
No longer needed thanks to 122eacd This was caught by a clippy lint.
1 parent e95db73 commit 69e7310

File tree

1 file changed

+86
-122
lines changed

1 file changed

+86
-122
lines changed

src/lib.rs

Lines changed: 86 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -319,13 +319,11 @@ use std::error::Error as StdError;
319319
/// [`OwnedKV`](struct.OwnedKV.html)
320320
///
321321
/// ```
322-
/// fn main() {
323-
/// let drain = slog::Discard;
324-
/// let _root = slog::Logger::root(
325-
/// drain,
326-
/// slog::o!("key1" => "value1", "key2" => "value2")
327-
/// );
328-
/// }
322+
/// let drain = slog::Discard;
323+
/// let _root = slog::Logger::root(
324+
/// drain,
325+
/// slog::o!("key1" => "value1", "key2" => "value2")
326+
/// );
329327
/// ```
330328
#[macro_export(local_inner_macros)]
331329
macro_rules! o(
@@ -511,41 +509,33 @@ macro_rules! slog_record(
511509
/// ### Simple
512510
///
513511
/// ```
514-
/// use slog::info;
515-
/// fn main() {
516-
/// let drain = slog::Discard;
517-
/// let root = slog::Logger::root(
518-
/// drain,
519-
/// slog::o!("key1" => "value1", "key2" => "value2")
520-
/// );
521-
/// slog::info!(root, "test info log"; "log-key" => true);
522-
/// }
512+
/// let drain = slog::Discard;
513+
/// let root = slog::Logger::root(
514+
/// drain,
515+
/// slog::o!("key1" => "value1", "key2" => "value2"),
516+
/// );
517+
/// slog::info!(root, "test info log"; "log-key" => true);
523518
/// ```
524519
///
525520
/// Note that `"key" => value` part is optional:
526521
///
527522
/// ```
528-
/// use slog::info;
529-
/// fn main() {
530-
/// let drain = slog::Discard;
531-
/// let root = slog::Logger::root(
532-
/// drain, slog::o!("key1" => "value1", "key2" => "value2")
533-
/// );
534-
/// info!(root, "test info log");
535-
/// }
523+
/// let drain = slog::Discard;
524+
/// let root = slog::Logger::root(
525+
/// drain,
526+
/// slog::o!("key1" => "value1", "key2" => "value2"),
527+
/// );
528+
/// slog::info!(root, "test info log");
536529
/// ```
537530
///
538531
/// ### Formatting support:
539532
///
540533
/// ```
541-
/// use slog::info;
542-
/// fn main() {
543-
/// let drain = slog::Discard;
544-
/// let root = slog::Logger::root(drain,
545-
/// slog::o!("key1" => "value1", "key2" => "value2")
546-
/// );
547-
/// info!(root, "formatted {num_entries} entries of {}", "something", num_entries = 2; "log-key" => true);
548-
/// }
534+
/// let drain = slog::Discard;
535+
/// let root = slog::Logger::root(drain,
536+
/// slog::o!("key1" => "value1", "key2" => "value2")
537+
/// );
538+
/// slog::info!(root, "formatted {num_entries} entries of {}", "something", num_entries = 2; "log-key" => true);
549539
/// ```
550540
///
551541
/// Note:
@@ -557,14 +547,12 @@ macro_rules! slog_record(
557547
/// `"key" => value` part is optional:
558548
///
559549
/// ```
560-
/// use slog::info;
561-
/// fn main() {
562-
/// let drain = slog::Discard;
563-
/// let root = slog::Logger::root(
564-
/// drain, slog::o!("key1" => "value1", "key2" => "value2")
565-
/// );
566-
/// info!(root, "formatted: {}", 1);
567-
/// }
550+
/// let drain = slog::Discard;
551+
/// let root = slog::Logger::root(
552+
/// drain,
553+
/// slog::o!("key1" => "value1", "key2" => "value2"),
554+
/// );
555+
/// slog::info!(root, "formatted: {}", 1);
568556
/// ```
569557
///
570558
/// Use formatting support wisely. Prefer named arguments, so the associated
@@ -576,18 +564,15 @@ macro_rules! slog_record(
576564
/// with `#`.
577565
///
578566
/// ```
579-
/// use slog::info;
580-
/// fn main() {
581-
/// let drain = slog::Discard;
582-
/// let root = slog::Logger::root(drain,
583-
/// slog::o!("key1" => "value1", "key2" => "value2")
584-
/// );
585-
/// let ops = 3;
586-
/// slog::info!(
587-
/// root,
588-
/// #"performance-metric", "thread speed"; "ops_per_sec" => ops
589-
/// );
590-
/// }
567+
/// let drain = slog::Discard;
568+
/// let root = slog::Logger::root(drain,
569+
/// slog::o!("key1" => "value1", "key2" => "value2")
570+
/// );
571+
/// let ops = 3;
572+
/// slog::info!(
573+
/// root,
574+
/// #"performance-metric", "thread speed"; "ops_per_sec" => ops
575+
/// );
591576
/// ```
592577
///
593578
/// See `Record::tag()` for more information about tags.
@@ -602,40 +587,30 @@ macro_rules! slog_record(
602587
/// `=>` syntax.
603588
///
604589
/// ```
605-
/// use slog::*;
590+
/// use slog::{KV, Value, Record, Serializer, Key, o, info};
591+
/// struct MyKV;
592+
/// struct MyV;
606593
///
607-
/// fn main() {
608-
/// struct MyKV;
609-
/// struct MyV;
610-
///
611-
/// impl KV for MyKV {
612-
/// fn serialize(&self,
613-
/// _record: &Record,
614-
/// serializer: &mut dyn Serializer)
615-
/// -> Result {
616-
/// serializer.emit_u32("MyK".into(), 16)
617-
/// }
594+
/// impl KV for MyKV {
595+
/// fn serialize(&self, _record: &Record, serializer: &mut dyn Serializer) -> slog::Result {
596+
/// serializer.emit_u32("MyK".into(), 16)
618597
/// }
598+
/// }
619599
///
620-
/// impl Value for MyV {
621-
/// fn serialize(&self,
622-
/// _record: &Record,
623-
/// key : Key,
624-
/// serializer: &mut dyn Serializer)
625-
/// -> Result {
626-
/// serializer.emit_u32("MyKV".into(), 16)
627-
/// }
600+
/// impl Value for MyV {
601+
/// fn serialize(&self, _record: &Record, key: Key, serializer: &mut dyn Serializer) -> slog::Result {
602+
/// serializer.emit_u32("MyKV".into(), 16)
628603
/// }
604+
/// }
629605
///
630-
/// let drain = slog::Discard;
606+
/// let drain = slog::Discard;
631607
///
632-
/// let root = slog::Logger::root(drain, o!(MyKV));
608+
/// let root = slog::Logger::root(drain, o!(MyKV));
633609
///
634-
/// info!(
635-
/// root,
636-
/// "testing MyV"; "MyV" => MyV
637-
/// );
638-
/// }
610+
/// info!(
611+
/// root,
612+
/// "testing MyV"; "MyV" => MyV
613+
/// );
639614
/// ```
640615
///
641616
/// ### `fmt::Display` and `fmt::Debug` values
@@ -659,17 +634,14 @@ macro_rules! slog_record(
659634
/// [`kv` macro](macro.log.html)
660635
///
661636
/// ```
662-
/// use std::fmt::Write;
663-
///
664-
/// fn main() {
665-
/// let drain = slog::Discard;
666-
/// let log = slog::Logger::root(drain, slog::o!());
637+
/// # use std::fmt::Write;
638+
/// let drain = slog::Discard;
639+
/// let log = slog::Logger::root(drain, slog::o!());
667640
///
668-
/// let mut output = String::new();
641+
/// let mut output = String::new();
669642
///
670-
/// if let Err(e) = write!(&mut output, "write to string") {
671-
/// slog::error!(log, "write failed"; "err" => %e);
672-
/// }
643+
/// if let Err(e) = write!(&mut output, "write to string") {
644+
/// slog::error!(log, "write failed"; "err" => %e);
673645
/// }
674646
/// ```
675647
#[macro_export(local_inner_macros)]
@@ -1007,12 +979,10 @@ where
1007979
/// Use `o!` macro to build `OwnedKV` object.
1008980
///
1009981
/// ```
1010-
/// fn main() {
1011-
/// let _root = slog::Logger::root(
1012-
/// slog::Discard,
1013-
/// slog::o!("key1" => "value1", "key2" => "value2"),
1014-
/// );
1015-
/// }
982+
/// let _root = slog::Logger::root(
983+
/// slog::Discard,
984+
/// slog::o!("key1" => "value1", "key2" => "value2"),
985+
/// );
1016986
/// ```
1017987
pub fn root<T>(drain: D, values: OwnedKV<T>) -> Logger
1018988
where
@@ -1075,12 +1045,12 @@ where
10751045
///
10761046
/// ```
10771047
/// use slog::o;
1078-
///
1079-
/// fn main() {
1080-
/// let root = slog::Logger::root(slog::Discard,
1081-
/// o!("key1" => "value1", "key2" => "value2"));
1082-
/// let _log = root.new(o!("key" => "value"));
1083-
/// }
1048+
/// let root = slog::Logger::root(
1049+
/// slog::Discard,
1050+
/// o!("key1" => "value1", "key2" => "value2"),
1051+
/// );
1052+
/// let _log = root.new(slog::o!("key" => "value"));
1053+
/// ```
10841054
#[allow(clippy::wrong_self_convention)]
10851055
pub fn new<T>(&self, values: OwnedKV<T>) -> Logger<D>
10861056
where
@@ -1301,11 +1271,8 @@ pub trait Drain {
13011271
/// into another `Drain`.
13021272
///
13031273
/// ```
1304-
/// use slog::*;
1305-
///
1306-
/// fn main() {
1307-
/// let _drain = Discard.map(Fuse);
1308-
/// }
1274+
/// use slog::{Discard, Fuse, Drain, o};
1275+
/// let _drain = Discard.map(Fuse);
13091276
/// ```
13101277
fn map<F, R>(self, f: F) -> R
13111278
where
@@ -3257,23 +3224,20 @@ impl Drop for PushFnValueSerializer<'_> {
32573224
///
32583225
/// ```
32593226
/// use slog::{PushFnValue, Logger, Discard};
3260-
///
3261-
/// fn main() {
3262-
/// // Create a logger with a key-value printing
3263-
/// // `file:line` string value for every logging statement.
3264-
/// // `Discard` `Drain` used for brevity.
3265-
/// let root = Logger::root(Discard, slog::o!(
3266-
/// "source_location" => PushFnValue(|record , s| {
3267-
/// s.serialize(
3268-
/// format_args!(
3269-
/// "{}:{}",
3270-
/// record.file(),
3271-
/// record.line(),
3272-
/// )
3273-
/// )
3274-
/// })
3275-
/// ));
3276-
/// }
3227+
/// // Create a logger with a key-value printing
3228+
/// // `file:line` string value for every logging statement.
3229+
/// // `Discard` `Drain` used for brevity.
3230+
/// let root = Logger::root(Discard, slog::o!(
3231+
/// "source_location" => PushFnValue(|record , s| {
3232+
/// s.serialize(
3233+
/// format_args!(
3234+
/// "{}:{}",
3235+
/// record.file(),
3236+
/// record.line(),
3237+
/// )
3238+
/// )
3239+
/// })
3240+
/// ));
32773241
/// ```
32783242
#[must_use = "must be passed to logger to actually log"]
32793243
pub struct PushFnValue<F>(pub F)

0 commit comments

Comments
 (0)