From ab33adc799c1fe452801281a324bf9562f6f0927 Mon Sep 17 00:00:00 2001 From: Noah Hellman Date: Sun, 23 Apr 2023 16:32:20 +0200 Subject: [PATCH] lib: cfg guard doctests using html renderer docs do not compile when html feature is off otherwise --- src/lib.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index bf9063d..05e1228 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -85,21 +85,27 @@ type CowStr<'s> = std::borrow::Cow<'s, str>; /// Push to a [`String`] (implements [`std::fmt::Write`]): /// /// ``` +/// # #[cfg(feature = "html")] +/// # { /// # use jotdown::Render; /// # let events = std::iter::empty(); /// let mut output = String::new(); /// let mut renderer = jotdown::html::Renderer::default(); /// renderer.push(events, &mut output); +/// # } /// ``` /// /// Write to standard output with buffering ([`std::io::Stdout`] implements [`std::io::Write`]): /// /// ``` +/// # #[cfg(feature = "html")] +/// # { /// # use jotdown::Render; /// # let events = std::iter::empty(); /// let mut out = std::io::BufWriter::new(std::io::stdout()); /// let mut renderer = jotdown::html::Renderer::default(); /// renderer.write(events, &mut out).unwrap(); +/// # } /// ``` pub trait Render { /// Render a single event. @@ -166,11 +172,14 @@ pub trait Render { /// /// Render a borrowed slice of [`Event`]s. /// ``` + /// # #[cfg(feature = "html")] + /// # { /// # use jotdown::Render; /// # let events: &[jotdown::Event] = &[]; /// let mut output = String::new(); /// let mut renderer = jotdown::html::Renderer::default(); /// renderer.push_borrowed(events.iter(), &mut output); + /// # } /// ``` fn push_borrowed<'s, E, I, W>(&mut self, mut events: I, mut out: W) -> fmt::Result where